host_project_registrations

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

Overview

Name	host_project_registrations
Type	Resource
Id	google.apihub.host_project_registrations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
createTime	string (google-datetime)	Output only. The time at which the host project registration was created.
gcpProject	string	Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
createTime	string (google-datetime)	Output only. The time at which the host project registration was created.
gcpProject	string	Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, hostProjectRegistrationsId		Get a host project registration.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists host project registrations.
create	insert	projectsId, locationsId	hostProjectRegistrationId	Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.

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
hostProjectRegistrationsId	string
locationsId	string
projectsId	string
filter	string
hostProjectRegistrationId	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Get a host project registration.

SELECT
name,
createTime,
gcpProject
FROM google.apihub.host_project_registrations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND hostProjectRegistrationsId = '{{ hostProjectRegistrationsId }}' -- required;

list

Lists host project registrations.

SELECT
name,
createTime,
gcpProject
FROM google.apihub.host_project_registrations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.

INSERT INTO google.apihub.host_project_registrations (
data__name,
data__gcpProject,
projectsId,
locationsId,
hostProjectRegistrationId
)
SELECT 
'{{ name }}',
'{{ gcpProject }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ hostProjectRegistrationId }}'
RETURNING
name,
createTime,
gcpProject
;

Manifest

# Description fields are for documentation purposes
- name: host_project_registrations
  props:
    - name: projectsId
      value: string
      description: Required parameter for the host_project_registrations resource.
    - name: locationsId
      value: string
      description: Required parameter for the host_project_registrations resource.
    - name: name
      value: string
      description: >
        Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
        
    - name: gcpProject
      value: string
      description: >
        Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
        
    - name: hostProjectRegistrationId
      value: string