View Source GoogleApi.SASPortal.V1alpha1.Api.Deployments (google_api_sas_portal v0.17.0)
API calls for all endpoints tagged Deployments
.
Summary
Functions
Deletes a device.
Gets details about a device.
Moves a device under another node or customer.
Updates a device.
Signs a device.
Updates a signed device.
Returns a requested deployment.
Functions
Link to this function
sasportal_deployments_devices_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_devices_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a device.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the device. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalEmpty{}}
on success -
{:error, info}
on failure
Link to this function
sasportal_deployments_devices_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_devices_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details about a device.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the device. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice{}}
on success -
{:error, info}
on failure
Link to this function
sasportal_deployments_devices_move(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_devices_move( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalOperation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Moves a device under another node or customer.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the device to move. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.SASPortal.V1alpha1.Model.SasPortalMoveDeviceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalOperation{}}
on success -
{:error, info}
on failure
Link to this function
sasportal_deployments_devices_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_devices_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a device.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The resource path name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Fields to be updated. -
:body
(type:GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice{}}
on success -
{:error, info}
on failure
Link to this function
sasportal_deployments_devices_sign_device(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_devices_sign_device( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalEmpty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Signs a device.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The resource path name. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.SASPortal.V1alpha1.Model.SasPortalSignDeviceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalEmpty{}}
on success -
{:error, info}
on failure
Link to this function
sasportal_deployments_devices_update_signed(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_devices_update_signed( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a signed device.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the device to update. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.SASPortal.V1alpha1.Model.SasPortalUpdateSignedDeviceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalDevice{}}
on success -
{:error, info}
on failure
Link to this function
sasportal_deployments_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec sasportal_deployments_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.SASPortal.V1alpha1.Model.SasPortalDeployment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns a requested deployment.
Parameters
-
connection
(type:GoogleApi.SASPortal.V1alpha1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the deployment. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.SASPortal.V1alpha1.Model.SasPortalDeployment{}}
on success -
{:error, info}
on failure