applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	google.apphub.applications

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of an Application. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}"
attributes	object	Optional. Consumer provided attributes. (id: Attributes)
createTime	string (google-datetime)	Output only. Create time.
description	string	Optional. User-defined description of an Application. Can have a maximum length of 2048 characters.
displayName	string	Optional. User-defined name for the Application. Can have a maximum length of 63 characters.
scope	object	Required. Immutable. Defines what data can be included into this Application. Limits which Services and Workloads can be registered. (id: Scope)
state	string	Output only. Application state. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING)
uid	string	Output only. A universally unique identifier (in UUID4 format) for the Application.
updateTime	string (google-datetime)	Output only. Update time.

list

Name	Datatype	Description
name	string	Identifier. The resource name of an Application. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}"
attributes	object	Optional. Consumer provided attributes. (id: Attributes)
createTime	string (google-datetime)	Output only. Create time.
description	string	Optional. User-defined description of an Application. Can have a maximum length of 2048 characters.
displayName	string	Optional. User-defined name for the Application. Can have a maximum length of 63 characters.
scope	object	Required. Immutable. Defines what data can be included into this Application. Limits which Services and Workloads can be registered. (id: Scope)
state	string	Output only. Application state. (STATE_UNSPECIFIED, CREATING, ACTIVE, DELETING)
uid	string	Output only. A universally unique identifier (in UUID4 format) for the Application.
updateTime	string (google-datetime)	Output only. Update time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, applicationsId		Gets an Application in a host project and location.
list	select	projectsId, locationsId	pageSize, orderBy, pageToken, filter	Lists Applications in a host project and location.
create	insert	projectsId, locationsId	applicationId, requestId	Creates an Application in a host project and location.
patch	update	projectsId, locationsId, applicationsId	updateMask, requestId	Updates an Application in a host project and location.
delete	delete	projectsId, locationsId, applicationsId	requestId	Deletes an Application in a host project and location.

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
applicationsId	string
locationsId	string
projectsId	string
applicationId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an Application in a host project and location.

SELECT
name,
attributes,
createTime,
description,
displayName,
scope,
state,
uid,
updateTime
FROM google.apphub.applications
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND applicationsId = '{{ applicationsId }}' -- required
;

list

Lists Applications in a host project and location.

SELECT
name,
attributes,
createTime,
description,
displayName,
scope,
state,
uid,
updateTime
FROM google.apphub.applications
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

INSERT examples

create

Creates an Application in a host project and location.

INSERT INTO google.apphub.applications (
data__attributes,
data__displayName,
data__scope,
data__name,
data__description,
projectsId,
locationsId,
applicationId,
requestId
)
SELECT 
'{{ attributes }}',
'{{ displayName }}',
'{{ scope }}',
'{{ name }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ applicationId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the applications resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the applications resource.
  - name: attributes
    description: |
      Optional. Consumer provided attributes.
    value:
      environment:
        type: "{{ type }}"
      developerOwners:
        - email: "{{ email }}"
          displayName: "{{ displayName }}"
      criticality:
        type: "{{ type }}"
      businessOwners:
        - email: "{{ email }}"
          displayName: "{{ displayName }}"
      operatorOwners:
        - email: "{{ email }}"
          displayName: "{{ displayName }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. User-defined name for the Application. Can have a maximum length of 63 characters.
  - name: scope
    description: |
      Required. Immutable. Defines what data can be included into this Application. Limits which Services and Workloads can be registered.
    value:
      type: "{{ type }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of an Application. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}"`
  - name: description
    value: "{{ description }}"
    description: |
      Optional. User-defined description of an Application. Can have a maximum length of 2048 characters.
  - name: applicationId
    value: "{{ applicationId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates an Application in a host project and location.

UPDATE google.apphub.applications
SET 
data__attributes = '{{ attributes }}',
data__displayName = '{{ displayName }}',
data__scope = '{{ scope }}',
data__name = '{{ name }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes an Application in a host project and location.

DELETE FROM google.apphub.applications
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND applicationsId = '{{ applicationsId }}' --required
AND requestId = '{{ requestId }}'
;