Package-level declarations

Types

Link copied to clipboard
data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Link copied to clipboard
data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class ContactResponse(val email: String, val faxNumber: String, val phoneNumber: String, val postalAddress: PostalAddressResponse)

Details required for a contact associated with a Registration.

Link copied to clipboard
data class ContactSettingsResponse(val adminContact: ContactResponse, val privacy: String, val registrantContact: ContactResponse, val technicalContact: ContactResponse)

Defines the contact information associated with a Registration. ICANN requires all domain names to have associated contact information. The registrant_contact is considered the domain's legal owner, and often the other contacts are identical.

Link copied to clipboard
data class CustomDnsResponse(val dsRecords: List<DsRecordResponse>, val nameServers: List<String>)

Configuration for an arbitrary DNS provider.

Link copied to clipboard
data class DnsSettingsResponse(val customDns: CustomDnsResponse, val glueRecords: List<GlueRecordResponse>, val googleDomainsDns: GoogleDomainsDnsResponse)

Defines the DNS configuration of a Registration, including name servers, DNSSEC, and glue records.

Link copied to clipboard
data class DsRecordResponse(val algorithm: String, val digest: String, val digestType: String, val keyTag: Int)

Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class GetRegistrationIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetRegistrationResult(val contactSettings: ContactSettingsResponse, val createTime: String, val dnsSettings: DnsSettingsResponse, val domainName: String, val expireTime: String, val issues: List<String>, val labels: Map<String, String>, val managementSettings: ManagementSettingsResponse, val name: String, val pendingContactSettings: ContactSettingsResponse, val registerFailureReason: String, val state: String, val supportedPrivacy: List<String>, val transferFailureReason: String)
Link copied to clipboard
data class GlueRecordResponse(val hostName: String, val ipv4Addresses: List<String>, val ipv6Addresses: List<String>)

Defines a host on your domain that is a DNS name server for your domain and/or other domains. Glue records are a way of making the IP address of a name server known, even when it serves DNS queries for its parent domain. For example, when ns.example.com is a name server for example.com, the host ns.example.com must have a glue record to break the circular DNS reference.

Link copied to clipboard
data class GoogleDomainsDnsResponse(val dsRecords: List<DsRecordResponse>, val dsState: String, val nameServers: List<String>)

Configuration for using the free DNS zone provided by Google Domains as a Registration's dns_provider. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to Google Domains.

Link copied to clipboard
data class ManagementSettingsResponse(val renewalMethod: String, val transferLockState: String)

Defines renewal, billing, and transfer settings for a Registration.

Link copied to clipboard
data class PostalAddressResponse(val addressLines: List<String>, val administrativeArea: String, val languageCode: String, val locality: String, val organization: String, val postalCode: String, val recipients: List<String>, val regionCode: String, val revision: Int, val sortingCode: String, val sublocality: String)

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478