Returns the actuations Resource.
Close httplib2 connections.
create(parent, body=None, deploymentId=None, requestId=None, x__xgafv=None)
Creates a new Deployment in a given project and location.
delete(name, force=None, x__xgafv=None)
Deletes a single Deployment.
Gets details of a single Deployment.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Deployments in a given project and location.
Retrieves the next page of results.
close()
Close httplib2 connections.
create(parent, body=None, deploymentId=None, requestId=None, x__xgafv=None)
Creates a new Deployment in a given project and location.
Args:
parent: string, Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}` (required)
body: object, The request body.
The object takes the form of:
{ # The Deployment object represents user intent for deploying a specific type of workload.
"createTime": "A String", # Output only. Create time stamp.
"description": "A String", # Description of the deployment.
"name": "A String", # The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
"sapSystemS4Config": { # Message for SAP system workload. # SAP system workload input.
"allowStoppingForUpdate": True or False,
"ansibleRunnerServiceAccount": "A String", # Ansible runner service account. Let customers bring their own service account for the Ansible runner.
"app": { # Message for SAP instance details. # Instance details.
"appInstanceId": "A String", # Optional. Instance ID for app.
"appServiceAccount": "A String", # Application service account. Let customers bring their own service account for the application.
"appVmNames": [ # Optional. Customized VM names.
"A String",
],
"ascsImage": "A String", # Required. Image for the ASCS server.
"ascsInstanceId": "A String", # Optional. Instance ID for ASCS.
"ascsMachineType": "A String", # Required. ASCS machine type.
"ascsServiceAccount": "A String", # ASCS service account. Let customers bring their own service account for ASCS.
"ascsVm": "A String", # Optional. ASCS VM name.
"ersInstanceId": "A String", # Optional. Instance ID for ERS.
"ersVm": "A String", # Optional. ERS VM name.
"image": "A String", # Required. Image for the app server and ASCS server.
"machineType": "A String", # Required. Machine type.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"sharedStorage": "A String", # Optional. Storage location.
"sid": "A String", # Required. The SAP SID is a three-digit server-specific unique identification code.
"vmsMultiplier": 42, # Required. VMs multiplier.
},
"database": { # Message for SAP instance details. # Database details.
"databaseServiceAccount": "A String", # Database service account. Let customers bring their own SA for the database.
"diskType": "A String", # Required. Disk type.
"image": "A String", # Required. Image for the database server.
"instanceId": "A String", # Optional. Instance ID.
"machineType": "A String", # Required. Machine type.
"primaryDbVm": "A String", # Optional. Primary DB VM name.
"secondaryDbVm": "A String", # Optional. Secondary DB VM name.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"sid": "A String", # Required. The SID is a three-digit server-specific unique identification code.
},
"deploymentModel": "A String", # Required. Supports non-HA and HA models.
"environmentType": "A String", # Required. Deployment environment.
"gcpProjectId": "A String", # The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.
"location": { # Message for SAP instance details. # Database details.
"createCommsFirewall": True or False, # Optional. Create firewall. If true, creates a firewall for the deployment. This field provides an option to not always create a firewall for the deployment.
"customTags": [ # Optional. Network tags.
"A String",
],
"deploymentDnsEnabled": True or False, # Optional. When the user skips DNS configuration in the UI, `deployment_dns_enabled` is false; otherwise `deployment_dns_enabled` is true.
"dnsZone": "A String", # Optional. DNS zone name.
"dnsZoneNameSuffix": "A String", # Optional. DNS zone name suffix.
"internetAccess": "A String",
"networkProject": "A String", # Optional. Network project.
"regionName": "A String", # Required. Region name.
"subnetName": "A String", # Required. Subnet name.
"vpcName": "A String", # Required. VPC name.
"zone1Name": "A String", # Required. Zone 1 name.
"zone2Name": "A String", # Optional. Zone 2 name.
},
"mediaBucketName": "A String", # Required. Media bucket name.
"sapBootDiskImage": "A String", # Optional. SAP boot disk image.
"scalingMethod": "A String", # Required. Supports scale up and scale out.
"version": "A String", # Required. SAP HANA version.
"vmPrefix": "A String", # VM prefix.
},
"serviceAccount": "A String", # User-specified Service Account (SA) credentials to be used for Cloud Build. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation.
"sqlServerWorkload": { # Message for MS SQL workload. # MS SQL workload input.
"activeDirectory": { # Active Directory details. # Required. Active Directory details.
"dnsAddress": "A String", # Optional. DNS IP address.
"domain": "A String", # Optional. Human readable form of a domain such as “google.com”.
"domainUsername": "A String", # Optional. Domain username.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"type": "A String", # Required. Active Directory type.
},
"computeEngineServiceAccount": "A String", # Compute Engine service account. Let customers bring their own service account for Compute Engine.
"database": { # Database details. # Required. Database details.
"diskType": "A String", # Required. Disk type.
"floatingIpAddress": "A String", # Optional. Only useful for Linux High Availability setup.
"machineType": "A String", # Required. Machine type.
"secondarySoleTenantNode": "A String", # Optional. The name of a secondary-sole-tenant node/node group.
"secondarySoleTenantNodeType": "A String", # Optional. The type of a secondary-sole-tenant node/node group. E.g., compute.googleapis.com/node-name.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"smt": True or False, # Required. Whether simultaneous multithreading is enabled or not.
"soleTenantNode": "A String", # Optional. The name of a primary sole-tenant node/node group.
"soleTenantNodeType": "A String", # Optional. The type of a primary sole-tenant node/node group. E.g., compute.googleapis.com/node-name.
"tempdbOnSsd": True or False, # Required. Whether to have TempDB on local SSD.
"tenancyModel": "A String", # Required. SHARED or SOLE_TENANT.
},
"deploymentModel": "A String", # Required. HIGH_AVAILABILITY or SINGLE_INSTANCE.
"environmentType": "A String", # Required. Deployment environment.
"fciType": "A String", # Optional. SHARED_DISK or S2D.
"haType": "A String", # Optional. AOAG or FCI. It is only needed for the High Availability deployment mode.
"isSqlPayg": True or False, # Required. SQL licensing type.
"location": { # Location and networking details for configuring SQL server workload. # Required. Location details.
"dnsZone": "A String", # Optional. Create a new DNS zone when the field is empty. Only shown for `Using an existing DNS`. List of existing DNS zones. Terraform variable name: existing_dns_zone_name.
"gcpProjectId": "A String", # Required. The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.
"internetAccess": "A String", # Required. Internet Access.
"network": "A String", # Required. Network name.
"primaryZone": "A String", # Required. Primary zone.
"region": "A String", # Required. Region name.
"secondaryZone": "A String", # Optional. Secondary zone cannot be the same as primary_zone and is only for High Availability deployment mode.
"subnetwork": "A String", # Required. Subnetwork name.
"tertiaryZone": "A String", # Optional. Tertiary zone cannot be the same as primary_zone and secondary_zone, and it is only for High Availability deployment mode.
},
"mediaBucket": "A String", # Required. Name of the media storing SQL server installation files.
"operatingSystemType": "A String", # Required. The type of the operating system the SQL server is going to run on top of.
"osImage": "A String", # Required. The image of the operating system.
"osImageType": "A String", # Optional. OS image type. It's used to create boot disks for VM instances. When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and defaults to a custom image.
"pacemaker": { # Pacemaker configuration. # Optional. Pacemaker configuration, only applicable for Linux HA deployments.
"bucketNameNodeCertificates": "A String", # Required. Bucket location for node certificates.
"pacemakerCluster": "A String", # Required. Pacemaker cluster name.
"pacemakerClusterSecret": "A String", # Required. Pacemaker cluster secret name.
"pacemakerClusterUsername": "A String", # Required. Pacemaker cluster username.
"sqlPacemakerSecret": "A String", # Required. SQL Pacemaker secret name.
"sqlPacemakerUsername": "A String", # Required. SQL Pacemaker username.
},
"sqlServerEdition": "A String", # Optional. SQL Server Edition type, only applicable when the operating system is Linux.
"sqlServerVersion": "A String", # Optional. 2017, 2019, or 2022.
"vmPrefix": "A String", # Required. Should be unique in the project.
},
"state": "A String", # Output only. Current state of the deployment.
"terraformVariables": { # Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
"a_key": { # In order to align with the Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest. A Terraform input variable.
"inputValue": "", # Optional. Input variable value.
},
},
"updateTime": "A String", # Output only. Update time stamp.
"workerPool": "A String", # Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
"workloadType": "A String", # Optional. Workload type of the deployment.
}
deploymentId: string, Required. ID of the deployment.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, force=None, x__xgafv=None)
Deletes a single Deployment.
Args:
name: string, Required. Name of the resource. (required)
force: boolean, Optional. If set to true, any actuation will also be deleted. Follows the best practice from https://aip.dev/135#cascading-delete.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets details of a single Deployment.
Args:
name: string, Required. Name of the resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Deployment object represents user intent for deploying a specific type of workload.
"createTime": "A String", # Output only. Create time stamp.
"description": "A String", # Description of the deployment.
"name": "A String", # The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
"sapSystemS4Config": { # Message for SAP system workload. # SAP system workload input.
"allowStoppingForUpdate": True or False,
"ansibleRunnerServiceAccount": "A String", # Ansible runner service account. Let customers bring their own service account for the Ansible runner.
"app": { # Message for SAP instance details. # Instance details.
"appInstanceId": "A String", # Optional. Instance ID for app.
"appServiceAccount": "A String", # Application service account. Let customers bring their own service account for the application.
"appVmNames": [ # Optional. Customized VM names.
"A String",
],
"ascsImage": "A String", # Required. Image for the ASCS server.
"ascsInstanceId": "A String", # Optional. Instance ID for ASCS.
"ascsMachineType": "A String", # Required. ASCS machine type.
"ascsServiceAccount": "A String", # ASCS service account. Let customers bring their own service account for ASCS.
"ascsVm": "A String", # Optional. ASCS VM name.
"ersInstanceId": "A String", # Optional. Instance ID for ERS.
"ersVm": "A String", # Optional. ERS VM name.
"image": "A String", # Required. Image for the app server and ASCS server.
"machineType": "A String", # Required. Machine type.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"sharedStorage": "A String", # Optional. Storage location.
"sid": "A String", # Required. The SAP SID is a three-digit server-specific unique identification code.
"vmsMultiplier": 42, # Required. VMs multiplier.
},
"database": { # Message for SAP instance details. # Database details.
"databaseServiceAccount": "A String", # Database service account. Let customers bring their own SA for the database.
"diskType": "A String", # Required. Disk type.
"image": "A String", # Required. Image for the database server.
"instanceId": "A String", # Optional. Instance ID.
"machineType": "A String", # Required. Machine type.
"primaryDbVm": "A String", # Optional. Primary DB VM name.
"secondaryDbVm": "A String", # Optional. Secondary DB VM name.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"sid": "A String", # Required. The SID is a three-digit server-specific unique identification code.
},
"deploymentModel": "A String", # Required. Supports non-HA and HA models.
"environmentType": "A String", # Required. Deployment environment.
"gcpProjectId": "A String", # The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.
"location": { # Message for SAP instance details. # Database details.
"createCommsFirewall": True or False, # Optional. Create firewall. If true, creates a firewall for the deployment. This field provides an option to not always create a firewall for the deployment.
"customTags": [ # Optional. Network tags.
"A String",
],
"deploymentDnsEnabled": True or False, # Optional. When the user skips DNS configuration in the UI, `deployment_dns_enabled` is false; otherwise `deployment_dns_enabled` is true.
"dnsZone": "A String", # Optional. DNS zone name.
"dnsZoneNameSuffix": "A String", # Optional. DNS zone name suffix.
"internetAccess": "A String",
"networkProject": "A String", # Optional. Network project.
"regionName": "A String", # Required. Region name.
"subnetName": "A String", # Required. Subnet name.
"vpcName": "A String", # Required. VPC name.
"zone1Name": "A String", # Required. Zone 1 name.
"zone2Name": "A String", # Optional. Zone 2 name.
},
"mediaBucketName": "A String", # Required. Media bucket name.
"sapBootDiskImage": "A String", # Optional. SAP boot disk image.
"scalingMethod": "A String", # Required. Supports scale up and scale out.
"version": "A String", # Required. SAP HANA version.
"vmPrefix": "A String", # VM prefix.
},
"serviceAccount": "A String", # User-specified Service Account (SA) credentials to be used for Cloud Build. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation.
"sqlServerWorkload": { # Message for MS SQL workload. # MS SQL workload input.
"activeDirectory": { # Active Directory details. # Required. Active Directory details.
"dnsAddress": "A String", # Optional. DNS IP address.
"domain": "A String", # Optional. Human readable form of a domain such as “google.com”.
"domainUsername": "A String", # Optional. Domain username.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"type": "A String", # Required. Active Directory type.
},
"computeEngineServiceAccount": "A String", # Compute Engine service account. Let customers bring their own service account for Compute Engine.
"database": { # Database details. # Required. Database details.
"diskType": "A String", # Required. Disk type.
"floatingIpAddress": "A String", # Optional. Only useful for Linux High Availability setup.
"machineType": "A String", # Required. Machine type.
"secondarySoleTenantNode": "A String", # Optional. The name of a secondary-sole-tenant node/node group.
"secondarySoleTenantNodeType": "A String", # Optional. The type of a secondary-sole-tenant node/node group. E.g., compute.googleapis.com/node-name.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"smt": True or False, # Required. Whether simultaneous multithreading is enabled or not.
"soleTenantNode": "A String", # Optional. The name of a primary sole-tenant node/node group.
"soleTenantNodeType": "A String", # Optional. The type of a primary sole-tenant node/node group. E.g., compute.googleapis.com/node-name.
"tempdbOnSsd": True or False, # Required. Whether to have TempDB on local SSD.
"tenancyModel": "A String", # Required. SHARED or SOLE_TENANT.
},
"deploymentModel": "A String", # Required. HIGH_AVAILABILITY or SINGLE_INSTANCE.
"environmentType": "A String", # Required. Deployment environment.
"fciType": "A String", # Optional. SHARED_DISK or S2D.
"haType": "A String", # Optional. AOAG or FCI. It is only needed for the High Availability deployment mode.
"isSqlPayg": True or False, # Required. SQL licensing type.
"location": { # Location and networking details for configuring SQL server workload. # Required. Location details.
"dnsZone": "A String", # Optional. Create a new DNS zone when the field is empty. Only shown for `Using an existing DNS`. List of existing DNS zones. Terraform variable name: existing_dns_zone_name.
"gcpProjectId": "A String", # Required. The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.
"internetAccess": "A String", # Required. Internet Access.
"network": "A String", # Required. Network name.
"primaryZone": "A String", # Required. Primary zone.
"region": "A String", # Required. Region name.
"secondaryZone": "A String", # Optional. Secondary zone cannot be the same as primary_zone and is only for High Availability deployment mode.
"subnetwork": "A String", # Required. Subnetwork name.
"tertiaryZone": "A String", # Optional. Tertiary zone cannot be the same as primary_zone and secondary_zone, and it is only for High Availability deployment mode.
},
"mediaBucket": "A String", # Required. Name of the media storing SQL server installation files.
"operatingSystemType": "A String", # Required. The type of the operating system the SQL server is going to run on top of.
"osImage": "A String", # Required. The image of the operating system.
"osImageType": "A String", # Optional. OS image type. It's used to create boot disks for VM instances. When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and defaults to a custom image.
"pacemaker": { # Pacemaker configuration. # Optional. Pacemaker configuration, only applicable for Linux HA deployments.
"bucketNameNodeCertificates": "A String", # Required. Bucket location for node certificates.
"pacemakerCluster": "A String", # Required. Pacemaker cluster name.
"pacemakerClusterSecret": "A String", # Required. Pacemaker cluster secret name.
"pacemakerClusterUsername": "A String", # Required. Pacemaker cluster username.
"sqlPacemakerSecret": "A String", # Required. SQL Pacemaker secret name.
"sqlPacemakerUsername": "A String", # Required. SQL Pacemaker username.
},
"sqlServerEdition": "A String", # Optional. SQL Server Edition type, only applicable when the operating system is Linux.
"sqlServerVersion": "A String", # Optional. 2017, 2019, or 2022.
"vmPrefix": "A String", # Required. Should be unique in the project.
},
"state": "A String", # Output only. Current state of the deployment.
"terraformVariables": { # Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
"a_key": { # In order to align with the Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest. A Terraform input variable.
"inputValue": "", # Optional. Input variable value.
},
},
"updateTime": "A String", # Output only. Update time stamp.
"workerPool": "A String", # Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
"workloadType": "A String", # Optional. Workload type of the deployment.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Deployments in a given project and location.
Args:
parent: string, Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}` (required)
filter: string, Optional. Filter resource following https://google.aip.dev/160.
orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing deployments.
"deployments": [ # The list of deployments.
{ # The Deployment object represents user intent for deploying a specific type of workload.
"createTime": "A String", # Output only. Create time stamp.
"description": "A String", # Description of the deployment.
"name": "A String", # The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'.
"sapSystemS4Config": { # Message for SAP system workload. # SAP system workload input.
"allowStoppingForUpdate": True or False,
"ansibleRunnerServiceAccount": "A String", # Ansible runner service account. Let customers bring their own service account for the Ansible runner.
"app": { # Message for SAP instance details. # Instance details.
"appInstanceId": "A String", # Optional. Instance ID for app.
"appServiceAccount": "A String", # Application service account. Let customers bring their own service account for the application.
"appVmNames": [ # Optional. Customized VM names.
"A String",
],
"ascsImage": "A String", # Required. Image for the ASCS server.
"ascsInstanceId": "A String", # Optional. Instance ID for ASCS.
"ascsMachineType": "A String", # Required. ASCS machine type.
"ascsServiceAccount": "A String", # ASCS service account. Let customers bring their own service account for ASCS.
"ascsVm": "A String", # Optional. ASCS VM name.
"ersInstanceId": "A String", # Optional. Instance ID for ERS.
"ersVm": "A String", # Optional. ERS VM name.
"image": "A String", # Required. Image for the app server and ASCS server.
"machineType": "A String", # Required. Machine type.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"sharedStorage": "A String", # Optional. Storage location.
"sid": "A String", # Required. The SAP SID is a three-digit server-specific unique identification code.
"vmsMultiplier": 42, # Required. VMs multiplier.
},
"database": { # Message for SAP instance details. # Database details.
"databaseServiceAccount": "A String", # Database service account. Let customers bring their own SA for the database.
"diskType": "A String", # Required. Disk type.
"image": "A String", # Required. Image for the database server.
"instanceId": "A String", # Optional. Instance ID.
"machineType": "A String", # Required. Machine type.
"primaryDbVm": "A String", # Optional. Primary DB VM name.
"secondaryDbVm": "A String", # Optional. Secondary DB VM name.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"sid": "A String", # Required. The SID is a three-digit server-specific unique identification code.
},
"deploymentModel": "A String", # Required. Supports non-HA and HA models.
"environmentType": "A String", # Required. Deployment environment.
"gcpProjectId": "A String", # The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.
"location": { # Message for SAP instance details. # Database details.
"createCommsFirewall": True or False, # Optional. Create firewall. If true, creates a firewall for the deployment. This field provides an option to not always create a firewall for the deployment.
"customTags": [ # Optional. Network tags.
"A String",
],
"deploymentDnsEnabled": True or False, # Optional. When the user skips DNS configuration in the UI, `deployment_dns_enabled` is false; otherwise `deployment_dns_enabled` is true.
"dnsZone": "A String", # Optional. DNS zone name.
"dnsZoneNameSuffix": "A String", # Optional. DNS zone name suffix.
"internetAccess": "A String",
"networkProject": "A String", # Optional. Network project.
"regionName": "A String", # Required. Region name.
"subnetName": "A String", # Required. Subnet name.
"vpcName": "A String", # Required. VPC name.
"zone1Name": "A String", # Required. Zone 1 name.
"zone2Name": "A String", # Optional. Zone 2 name.
},
"mediaBucketName": "A String", # Required. Media bucket name.
"sapBootDiskImage": "A String", # Optional. SAP boot disk image.
"scalingMethod": "A String", # Required. Supports scale up and scale out.
"version": "A String", # Required. SAP HANA version.
"vmPrefix": "A String", # VM prefix.
},
"serviceAccount": "A String", # User-specified Service Account (SA) credentials to be used for Cloud Build. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation.
"sqlServerWorkload": { # Message for MS SQL workload. # MS SQL workload input.
"activeDirectory": { # Active Directory details. # Required. Active Directory details.
"dnsAddress": "A String", # Optional. DNS IP address.
"domain": "A String", # Optional. Human readable form of a domain such as “google.com”.
"domainUsername": "A String", # Optional. Domain username.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"type": "A String", # Required. Active Directory type.
},
"computeEngineServiceAccount": "A String", # Compute Engine service account. Let customers bring their own service account for Compute Engine.
"database": { # Database details. # Required. Database details.
"diskType": "A String", # Required. Disk type.
"floatingIpAddress": "A String", # Optional. Only useful for Linux High Availability setup.
"machineType": "A String", # Required. Machine type.
"secondarySoleTenantNode": "A String", # Optional. The name of a secondary-sole-tenant node/node group.
"secondarySoleTenantNodeType": "A String", # Optional. The type of a secondary-sole-tenant node/node group. E.g., compute.googleapis.com/node-name.
"secretManagerSecret": "A String", # Required. Secret Manager secret.
"smt": True or False, # Required. Whether simultaneous multithreading is enabled or not.
"soleTenantNode": "A String", # Optional. The name of a primary sole-tenant node/node group.
"soleTenantNodeType": "A String", # Optional. The type of a primary sole-tenant node/node group. E.g., compute.googleapis.com/node-name.
"tempdbOnSsd": True or False, # Required. Whether to have TempDB on local SSD.
"tenancyModel": "A String", # Required. SHARED or SOLE_TENANT.
},
"deploymentModel": "A String", # Required. HIGH_AVAILABILITY or SINGLE_INSTANCE.
"environmentType": "A String", # Required. Deployment environment.
"fciType": "A String", # Optional. SHARED_DISK or S2D.
"haType": "A String", # Optional. AOAG or FCI. It is only needed for the High Availability deployment mode.
"isSqlPayg": True or False, # Required. SQL licensing type.
"location": { # Location and networking details for configuring SQL server workload. # Required. Location details.
"dnsZone": "A String", # Optional. Create a new DNS zone when the field is empty. Only shown for `Using an existing DNS`. List of existing DNS zones. Terraform variable name: existing_dns_zone_name.
"gcpProjectId": "A String", # Required. The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists.
"internetAccess": "A String", # Required. Internet Access.
"network": "A String", # Required. Network name.
"primaryZone": "A String", # Required. Primary zone.
"region": "A String", # Required. Region name.
"secondaryZone": "A String", # Optional. Secondary zone cannot be the same as primary_zone and is only for High Availability deployment mode.
"subnetwork": "A String", # Required. Subnetwork name.
"tertiaryZone": "A String", # Optional. Tertiary zone cannot be the same as primary_zone and secondary_zone, and it is only for High Availability deployment mode.
},
"mediaBucket": "A String", # Required. Name of the media storing SQL server installation files.
"operatingSystemType": "A String", # Required. The type of the operating system the SQL server is going to run on top of.
"osImage": "A String", # Required. The image of the operating system.
"osImageType": "A String", # Optional. OS image type. It's used to create boot disks for VM instances. When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and defaults to a custom image.
"pacemaker": { # Pacemaker configuration. # Optional. Pacemaker configuration, only applicable for Linux HA deployments.
"bucketNameNodeCertificates": "A String", # Required. Bucket location for node certificates.
"pacemakerCluster": "A String", # Required. Pacemaker cluster name.
"pacemakerClusterSecret": "A String", # Required. Pacemaker cluster secret name.
"pacemakerClusterUsername": "A String", # Required. Pacemaker cluster username.
"sqlPacemakerSecret": "A String", # Required. SQL Pacemaker secret name.
"sqlPacemakerUsername": "A String", # Required. SQL Pacemaker username.
},
"sqlServerEdition": "A String", # Optional. SQL Server Edition type, only applicable when the operating system is Linux.
"sqlServerVersion": "A String", # Optional. 2017, 2019, or 2022.
"vmPrefix": "A String", # Required. Should be unique in the project.
},
"state": "A String", # Output only. Current state of the deployment.
"terraformVariables": { # Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
"a_key": { # In order to align with the Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest. A Terraform input variable.
"inputValue": "", # Optional. Input variable value.
},
},
"updateTime": "A String", # Output only. Update time stamp.
"workerPool": "A String", # Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
"workloadType": "A String", # Optional. Workload type of the deployment.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Unordered list. Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.