deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	google.prod_tt_sasportal.deployments

Fields

The following fields are returned by SELECT queries:

customers_nodes_deployments_list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

customers_deployments_get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

nodes_nodes_deployments_list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

nodes_deployments_get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

customers_deployments_list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

nodes_deployments_list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

deployments_get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name.
displayName	string	The deployment's display name.
frns	array	Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
sasUserIds	array	User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
customers_nodes_deployments_list	select	customersId, nodesId	pageSize, pageToken, filter	Lists deployments.
customers_deployments_get	select	customersId, deploymentsId		Returns a requested deployment.
nodes_nodes_deployments_list	select	nodesId, nodesId1	pageSize, pageToken, filter	Lists deployments.
nodes_deployments_get	select	nodesId, deploymentsId		Returns a requested deployment.
customers_deployments_list	select	customersId	pageSize, pageToken, filter	Lists deployments.
nodes_deployments_list	select	nodesId	pageSize, pageToken, filter	Lists deployments.
deployments_get	select	deploymentsId		Returns a requested deployment.
customers_nodes_deployments_create	insert	customersId, nodesId		Creates a new deployment.
nodes_nodes_deployments_create	insert	nodesId, nodesId1		Creates a new deployment.
customers_deployments_create	insert	customersId		Creates a new deployment.
customers_deployments_patch	update	customersId, deploymentsId	updateMask	Updates an existing deployment.
nodes_deployments_patch	update	nodesId, deploymentsId	updateMask	Updates an existing deployment.
customers_deployments_delete	delete	customersId, deploymentsId		Deletes a deployment.
nodes_deployments_delete	delete	nodesId, deploymentsId		Deletes a deployment.
customers_deployments_move	exec	customersId, deploymentsId		Moves a deployment under another node or customer.
nodes_deployments_move	exec	nodesId, deploymentsId		Moves a deployment under another node or customer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customersId	string
deploymentsId	string
nodesId	string
nodesId1	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

customers_nodes_deployments_list

Lists deployments.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE customersId = '{{ customersId }}' -- required
AND nodesId = '{{ nodesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

customers_deployments_get

Returns a requested deployment.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE customersId = '{{ customersId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required;

nodes_nodes_deployments_list

Lists deployments.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE nodesId = '{{ nodesId }}' -- required
AND nodesId1 = '{{ nodesId1 }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

nodes_deployments_get

Returns a requested deployment.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE nodesId = '{{ nodesId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required;

customers_deployments_list

Lists deployments.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE customersId = '{{ customersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

nodes_deployments_list

Lists deployments.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE nodesId = '{{ nodesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

deployments_get

Returns a requested deployment.

SELECT
name,
displayName,
frns,
sasUserIds
FROM google.prod_tt_sasportal.deployments
WHERE deploymentsId = '{{ deploymentsId }}' -- required;

INSERT examples

customers_nodes_deployments_create

Creates a new deployment.

INSERT INTO google.prod_tt_sasportal.deployments (
data__displayName,
data__sasUserIds,
customersId,
nodesId
)
SELECT 
'{{ displayName }}',
'{{ sasUserIds }}',
'{{ customersId }}',
'{{ nodesId }}'
RETURNING
name,
displayName,
frns,
sasUserIds
;

nodes_nodes_deployments_create

Creates a new deployment.

INSERT INTO google.prod_tt_sasportal.deployments (
data__displayName,
data__sasUserIds,
nodesId,
nodesId1
)
SELECT 
'{{ displayName }}',
'{{ sasUserIds }}',
'{{ nodesId }}',
'{{ nodesId1 }}'
RETURNING
name,
displayName,
frns,
sasUserIds
;

customers_deployments_create

Creates a new deployment.

INSERT INTO google.prod_tt_sasportal.deployments (
data__displayName,
data__sasUserIds,
customersId
)
SELECT 
'{{ displayName }}',
'{{ sasUserIds }}',
'{{ customersId }}'
RETURNING
name,
displayName,
frns,
sasUserIds
;

Manifest

# Description fields are for documentation purposes
- name: deployments
  props:
    - name: customersId
      value: string
      description: Required parameter for the deployments resource.
    - name: nodesId
      value: string
      description: Required parameter for the deployments resource.
    - name: nodesId1
      value: string
      description: Required parameter for the deployments resource.
    - name: displayName
      value: string
      description: >
        The deployment's display name.
        
    - name: sasUserIds
      value: array
      description: >
        User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
        

UPDATE examples

customers_deployments_patch

Updates an existing deployment.

UPDATE google.prod_tt_sasportal.deployments
SET 
data__displayName = '{{ displayName }}',
data__sasUserIds = '{{ sasUserIds }}'
WHERE 
customersId = '{{ customersId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
frns,
sasUserIds;

nodes_deployments_patch

Updates an existing deployment.

UPDATE google.prod_tt_sasportal.deployments
SET 
data__displayName = '{{ displayName }}',
data__sasUserIds = '{{ sasUserIds }}'
WHERE 
nodesId = '{{ nodesId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
frns,
sasUserIds;

DELETE examples

customers_deployments_delete

Deletes a deployment.

DELETE FROM google.prod_tt_sasportal.deployments
WHERE customersId = '{{ customersId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required;

nodes_deployments_delete

Deletes a deployment.

DELETE FROM google.prod_tt_sasportal.deployments
WHERE nodesId = '{{ nodesId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required;

Lifecycle Methods

customers_deployments_move

Moves a deployment under another node or customer.

EXEC google.prod_tt_sasportal.deployments.customers_deployments_move 
@customersId='{{ customersId }}' --required, 
@deploymentsId='{{ deploymentsId }}' --required 
@@json=
'{
"destination": "{{ destination }}"
}';

nodes_deployments_move

Moves a deployment under another node or customer.

EXEC google.prod_tt_sasportal.deployments.nodes_deployments_move 
@nodesId='{{ nodesId }}' --required, 
@deploymentsId='{{ deploymentsId }}' --required 
@@json=
'{
"destination": "{{ destination }}"
}';