Gcp/privateca
@swamp/gcp/privatecav2026.07.29.1
01README
Google Cloud privateca infrastructure models
02Release Notes
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
03Models
@swamp/gcp/privateca/capoolsv2026.07.29.1capools.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| encryptionSpec? | object | Optional. When EncryptionSpec is provided, the Subject, SubjectAltNames, and the PEM-encoded certificate fields will be encrypted at rest. |
| issuancePolicy? | object | Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. |
| labels? | record | Optional. Labels with user-defined metadata. |
| name? | string | Identifier. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. |
| publishingOptions? | object | Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool. |
| tier? | enum | Required. Immutable. The Tier of this CaPool. |
| caPoolId? | string | Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` |
| requestId? | string | Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a caPools
fn get(identifier: string)
Get a caPools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the caPools |
fn update(identifier?: string)
Update caPools attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific caPools by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the caPools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the caPools |
fn sync(identifier?: string)
Sync caPools state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific caPools by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List caPools resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Only include resources that match the filter in the response. |
| orderBy? | string | Optional. Specify how the results should be sorted. |
| pageSize? | number | Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn fetch_ca_certs(requestId?: any)
fetch ca certs
| Argument | Type | Description |
|---|---|---|
| requestId? | any |
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A CaPool represents a group of CertificateAuthorities that form a trust ancho...
@swamp/gcp/privateca/capools-certificateauthoritiesv2026.07.29.1capools_certificateauthorities.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| config? | object | Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
| gcsBucket? | string | Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. |
| keySpec? | object | Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR. |
| labels? | record | Optional. Labels with user-defined metadata. |
| lifetime? | string | Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. |
| name? | string | Identifier. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. |
| subordinateConfig? | object | Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate. |
| type? | enum | Required. Immutable. The Type of this CertificateAuthority. |
| userDefinedAccessUrls? | object | Optional. User-defined URLs for CA certificate and CRLs. The service does not publish content to these URLs. It is up to the user to mirror content to these URLs. |
| certificateAuthorityId? | string | Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` |
| requestId? | string | Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a certificateAuthorities
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a certificateAuthorities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the certificateAuthorities |
fn update(identifier?: string, waitForReady?: boolean)
Update certificateAuthorities attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificateAuthorities by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the certificateAuthorities
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the certificateAuthorities |
fn sync(identifier?: string)
Sync certificateAuthorities state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificateAuthorities by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List certificateAuthorities resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Only include resources that match the filter in the response. |
| orderBy? | string | Optional. Specify how the results should be sorted. |
| pageSize? | number | Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn activate(pemCaCertificate?: any, requestId?: any, subordinateConfig?: any)
activate
| Argument | Type | Description |
|---|---|---|
| pemCaCertificate? | any | |
| requestId? | any | |
| subordinateConfig? | any |
fn disable(ignoreDependentResources?: any, requestId?: any)
disable
| Argument | Type | Description |
|---|---|---|
| ignoreDependentResources? | any | |
| requestId? | any |
fn enable(requestId?: any)
enable
| Argument | Type | Description |
|---|---|---|
| requestId? | any |
fn fetch()
fetch
fn undelete(requestId?: any)
undelete
| Argument | Type | Description |
|---|---|---|
| requestId? | any |
Resources
state(infinite)— A CertificateAuthority represents an individual Certificate Authority. A Cert...
@swamp/gcp/privateca/capools-certificateauthorities-certificaterevocationlistsv2026.07.29.1capools_certificateauthorities_certificaterevocationlists.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| accessUrl? | string | Output only. The location where 'pem_crl' can be accessed. |
| createTime? | string | Output only. The time at which this CertificateRevocationList was created. |
| labels? | record | Optional. Labels with user-defined metadata. |
| name? | string | Identifier. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`. |
| pemCrl? | string | Output only. The PEM-encoded X.509 CRL. |
| revisionId? | string | Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string. |
| revokedCertificates? | array | Output only. The revoked serial numbers that appear in pem_crl. |
| sequenceNumber? | string | Output only. The CRL sequence number that appears in pem_crl. |
| state? | enum | Output only. The State for this CertificateRevocationList. |
| updateTime? | string | Output only. The time at which this CertificateRevocationList was updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a certificateRevocationLists
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the certificateRevocationLists |
fn update(identifier?: string, waitForReady?: boolean)
Update certificateRevocationLists attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificateRevocationLists by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync(identifier?: string)
Sync certificateRevocationLists state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificateRevocationLists by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List certificateRevocationLists resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Only include resources that match the filter in the response. |
| orderBy? | string | Optional. Specify how the results should be sorted. |
| pageSize? | number | Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A CertificateRevocationList corresponds to a signed X.509 certificate Revocat...
@swamp/gcp/privateca/capools-certificatesv2026.07.29.1capools_certificates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| certificateTemplate? | string | Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. |
| config? | object | Immutable. A description of the certificate and key that does not require X.509 or ASN.1. |
| labels? | record | Optional. Labels with user-defined metadata. |
| lifetime? | string | Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. |
| name? | string | Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. |
| pemCsr? | string | Immutable. A pem-encoded X.509 certificate signing request (CSR). |
| requestedNotBeforeTime? | string | Optional. The requested not_before_time of this Certificate. This field may only be set if the CaPool.IssuancePolicy.allow_requester_specified_not_before_time field is set to true for the issuing CaPool. If this field is specified, the certificate will be issued with this 'not_before_time'. If this is not specified, the 'not_before_time' will be set to the issuance time or issuance time minus backdate_duration depending on the CaPool configuration. |
| subjectMode? | enum | Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. |
| certificateId? | string | Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.tier, but is optional and its value is ignored otherwise. |
| issuingCertificateAuthorityId? | string | Optional. The resource ID of the CertificateAuthority that should issue the certificate. This optional field will ignore the load-balancing scheme of the Pool and directly issue the certificate from the CA with the specified ID, contained in the same CaPool referenced by `parent`. Per-CA quota rules apply. If left empty, a CertificateAuthority will be chosen from the CaPool by the service. For example, to issue a Certificate from a Certificate Authority with resource name "projects/my-project/lo |
| requestId? | string | Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a certificates
fn get(identifier: string)
Get a certificates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the certificates |
fn update(identifier?: string)
Update certificates attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificates by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync certificates state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificates by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List certificates resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see [Certificates Filtering documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support). |
| orderBy? | string | Optional. Specify how the results should be sorted. For details on supported fields and syntax, see [Certificates Sorting documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support). |
| pageSize? | number | Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn revoke(reason?: any, requestId?: any)
revoke
| Argument | Type | Description |
|---|---|---|
| reason? | any | |
| requestId? | any |
Resources
state(infinite)— A Certificate corresponds to a signed X.509 certificate issued by a Certifica...
@swamp/gcp/privateca/certificatetemplatesv2026.07.29.1certificatetemplates.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| description? | string | Optional. A human-readable description of scenarios this template is intended for. |
| identityConstraints? | object | Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity. |
| labels? | record | Optional. Labels with user-defined metadata. |
| maximumLifetime? | string | Optional. The maximum lifetime allowed for issued Certificates that use this template. If the issuing CaPool resource's IssuancePolicy specifies a maximum_lifetime the minimum of the two durations will be the maximum lifetime for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
| name? | string | Identifier. The resource name for this CertificateTemplate in the format `projects/*/locations/*/certificateTemplates/*`. |
| passthroughExtensions? | object | Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines baseline_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate's X.509 extensions. These constraints do no |
| predefinedValues? | object | Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing CaPool's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail. |
| certificateTemplateId? | string | Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` |
| requestId? | string | Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a certificateTemplates
fn get(identifier: string)
Get a certificateTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the certificateTemplates |
fn update(identifier?: string)
Update certificateTemplates attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificateTemplates by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the certificateTemplates
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the certificateTemplates |
fn sync(identifier?: string)
Sync certificateTemplates state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific certificateTemplates by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List certificateTemplates resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Only include resources that match the filter in the response. |
| orderBy? | string | Optional. Specify how the results should be sorted. |
| pageSize? | number | Optional. Limit on the number of CertificateTemplates to include in the response. Further CertificateTemplates can subsequently be obtained by including the ListCertificateTemplatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy()
get iam policy
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A CertificateTemplate refers to a managed template for certificate issuance.
@swamp/gcp/privateca/locationsv2026.07.29.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions
2026.07.21.4
- Updated: locations, capools, capools_certificates
2026.07.21.1
- Updated: capools, capools_certificateauthorities, capools_certificates, certificatetemplates
2026.07.20.2
- Updated: locations, capools, capools_certificates
2026.07.20.1
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.07.18.2
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.07.17.2
- Updated: capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.07.17.1
- Updated: capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.06.08.2
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.06.07.1
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.05.26.1
- Updated: locations, capools, capools_certificates
2026.05.25.1
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
Modified 6 models
2026.05.24.1
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.05.21.2
- Updated: locations, capools, capools_certificateauthorities, capools_certificateauthorities_certificaterevocationlists, capools_certificates, certificatetemplates
2026.05.21.1
Modified 3 models
2026.05.20.1
- Updated: capools, capools_certificates
2026.05.19.2
2026.05.19.1
05Stats
A
100 / 100
Downloads
0
Archive size
135.2 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels