google_api_deployment_manager v0.8.0 GoogleApi.DeploymentManager.V2.Api.Deployments View Source
API calls for all endpoints tagged Deployments
.
Link to this section Summary
Functions
Cancels and removes the preview currently associated with the deployment.
Deletes a deployment and all of the resources in the deployment.
Gets information about a specific deployment.
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Creates a deployment and all of the resources described by the deployment manifest.
Lists all deployments for a given project.
Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
Sets the access control policy on the specified resource. Replaces any existing policy.
Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
Returns permissions that a caller has on the specified resource.
Updates a deployment and all of the resources described by the deployment manifest.
Link to this section Functions
deploymentmanager_deployments_cancel_preview(connection, project, deployment, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_cancel_preview( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Cancels and removes the preview currently associated with the deployment.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.deployment
(type:String.t
) - The name of the deployment for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.DeploymentManager.V2.Model.DeploymentsCancelPreviewRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Operation{}}
on success{:error, info}
on failure
deploymentmanager_deployments_delete(connection, project, deployment, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a deployment and all of the resources in the deployment.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.deployment
(type:String.t
) - The name of the deployment for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:deletePolicy
(type:String.t
) - Sets the policy to use for deleting resources.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Operation{}}
on success{:error, info}
on failure
deploymentmanager_deployments_get(connection, project, deployment, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Deployment.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets information about a specific deployment.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.deployment
(type:String.t
) - The name of the deployment for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Deployment{}}
on success{:error, info}
on failure
deploymentmanager_deployments_get_iam_policy(connection, project, resource, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.resource
(type:String.t
) - Name or id of the resource for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Policy{}}
on success{:error, info}
on failure
deploymentmanager_deployments_insert(connection, project, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a deployment and all of the resources described by the deployment manifest.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:createPolicy
(type:String.t
) - Sets the policy to use for creating new resources.:preview
(type:boolean()
) - If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.:body
(type:GoogleApi.DeploymentManager.V2.Model.Deployment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Operation{}}
on success{:error, info}
on failure
deploymentmanager_deployments_list(connection, project, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.DeploymentsListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Lists all deployments for a given project.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:filter
(type:String.t
) - A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
:maxResults
(type:integer()
) - The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500):orderBy
(type:String.t
) - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Currently, only sorting by name or creationTimestamp desc is supported.
:pageToken
(type:String.t
) - Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.DeploymentsListResponse{}}
on success{:error, info}
on failure
deploymentmanager_deployments_patch(connection, project, deployment, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.deployment
(type:String.t
) - The name of the deployment for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:createPolicy
(type:String.t
) - Sets the policy to use for creating new resources.:deletePolicy
(type:String.t
) - Sets the policy to use for deleting resources.:preview
(type:boolean()
) - If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.:body
(type:GoogleApi.DeploymentManager.V2.Model.Deployment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Operation{}}
on success{:error, info}
on failure
deploymentmanager_deployments_set_iam_policy(connection, project, resource, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.resource
(type:String.t
) - Name or id of the resource for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.DeploymentManager.V2.Model.GlobalSetPolicyRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Policy{}}
on success{:error, info}
on failure
deploymentmanager_deployments_stop(connection, project, deployment, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_stop( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.deployment
(type:String.t
) - The name of the deployment for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.DeploymentManager.V2.Model.DeploymentsStopRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Operation{}}
on success{:error, info}
on failure
deploymentmanager_deployments_test_iam_permissions(connection, project, resource, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.TestPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Returns permissions that a caller has on the specified resource.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - Project ID for this request.resource
(type:String.t
) - Name or id of the resource for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.DeploymentManager.V2.Model.TestPermissionsRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.TestPermissionsResponse{}}
on success{:error, info}
on failure
deploymentmanager_deployments_update(connection, project, deployment, optional_params \\ [], opts \\ [])
View Sourcedeploymentmanager_deployments_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DeploymentManager.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a deployment and all of the resources described by the deployment manifest.
Parameters
connection
(type:GoogleApi.DeploymentManager.V2.Connection.t
) - Connection to serverproject
(type:String.t
) - The project ID for this request.deployment
(type:String.t
) - The name of the deployment for this request.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:createPolicy
(type:String.t
) - Sets the policy to use for creating new resources.:deletePolicy
(type:String.t
) - Sets the policy to use for deleting resources.:preview
(type:boolean()
) - If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.:body
(type:GoogleApi.DeploymentManager.V2.Model.Deployment.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DeploymentManager.V2.Model.Operation{}}
on success{:error, info}
on failure