Managed Service for Microsoft Active Directory API Server

# generated by fastapi-codegen: # filename: openapi.yaml # timestamp: 2025-06-29T02:24:15+00:00 from __future__ import annotations from enum import Enum from typing import Any, Dict, List, Optional from pydantic import BaseModel, Field class State(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' CREATING = 'CREATING' ACTIVE = 'ACTIVE' FAILED = 'FAILED' DELETING = 'DELETING' class Type(Enum): TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED' ON_DEMAND = 'ON_DEMAND' SCHEDULED = 'SCHEDULED' SCHEMA_EXTENSION = 'SCHEMA_EXTENSION' class Backup(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The time the backups was created.' ) description: Optional[str] = Field( None, description='Optional. A short description of the backup.' ) labels: Optional[Dict[str, str]] = Field( None, description='Optional. Resource labels to represent user provided metadata.', ) name: Optional[str] = Field( None, description='Output only. The unique name of the Backup in the form of projects/{project_id}/locations/global/domains/{domain_name}/backups/{name}', ) state: Optional[State] = Field( None, description='Output only. The current state of the backup.' ) statusMessage: Optional[str] = Field( None, description='Output only. Additional information about the current status of this backup, if available.', ) type: Optional[Type] = Field( None, description='Output only. Indicates whether it’s an on-demand backup or scheduled.', ) updateTime: Optional[str] = Field( None, description='Output only. Last update time.' ) class CancelOperationRequest(BaseModel): pass class Certificate(BaseModel): expireTime: Optional[str] = Field(None, description='The certificate expire time.') issuingCertificate: Optional[Certificate] = Field( None, description='The issuer of this certificate.' ) subject: Optional[str] = Field(None, description='The certificate subject.') subjectAlternativeName: Optional[List[str]] = Field( None, description='The additional hostnames for the domain.' ) thumbprint: Optional[str] = Field( None, description='The certificate thumbprint which uniquely identifies the certificate.', ) class CheckMigrationPermissionRequest(BaseModel): pass class State1(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' DISABLED = 'DISABLED' ENABLED = 'ENABLED' NEEDS_MAINTENANCE = 'NEEDS_MAINTENANCE' class Date(BaseModel): day: Optional[int] = Field( None, description="Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", ) month: Optional[int] = Field( None, description='Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.', ) year: Optional[int] = Field( None, description='Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.', ) class DisableMigrationRequest(BaseModel): pass class State2(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' CREATING = 'CREATING' READY = 'READY' UPDATING = 'UPDATING' DELETING = 'DELETING' REPAIRING = 'REPAIRING' PERFORMING_MAINTENANCE = 'PERFORMING_MAINTENANCE' DOWN = 'DOWN' class DomainJoinMachineRequest(BaseModel): force: Optional[bool] = Field( None, description='Optional. force if True, forces domain join even if the computer account already exists.', ) ouName: Optional[str] = Field( None, description='Optional. OU name where the VM needs to be domain joined' ) vmIdToken: Optional[str] = Field( None, description='Required. Full instance id token of compute engine VM to verify instance identity. More about this: https://cloud.google.com/compute/docs/instances/verifying-instance-identity#request_signature', ) class DomainJoinMachineResponse(BaseModel): domainJoinBlob: Optional[str] = Field( None, description='Offline domain join blob as the response' ) class Empty(BaseModel): pass class Expr(BaseModel): description: Optional[str] = Field( None, description='Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.', ) expression: Optional[str] = Field( None, description='Textual representation of an expression in Common Expression Language syntax.', ) location: Optional[str] = Field( None, description='Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.', ) title: Optional[str] = Field( None, description='Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.', ) class ExtendSchemaRequest(BaseModel): description: Optional[str] = Field( None, description='Required. Description for Schema Change.' ) fileContents: Optional[str] = Field( None, description='File uploaded as a byte stream input.' ) gcsPath: Optional[str] = Field( None, description='File stored in Cloud Storage bucket and represented in the form projects/{project_id}/buckets/{bucket_name}/objects/{object_name} File should be in the same project as the domain.', ) class GoogleCloudManagedidentitiesV1OpMetadata(BaseModel): apiVersion: Optional[str] = Field( None, description='Output only. API version used to start the operation.' ) createTime: Optional[str] = Field( None, description='Output only. The time the operation was created.' ) endTime: Optional[str] = Field( None, description='Output only. The time the operation finished running.' ) requestedCancellation: Optional[bool] = Field( None, description='Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.', ) target: Optional[str] = Field( None, description='Output only. Server-defined resource path for the target of the operation.', ) verb: Optional[str] = Field( None, description='Output only. Name of the verb executed by the operation.' ) class GoogleCloudManagedidentitiesV1alpha1OpMetadata(BaseModel): apiVersion: Optional[str] = Field( None, description='Output only. API version used to start the operation.' ) createTime: Optional[str] = Field( None, description='Output only. The time the operation was created.' ) endTime: Optional[str] = Field( None, description='Output only. The time the operation finished running.' ) requestedCancellation: Optional[bool] = Field( None, description='Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.', ) target: Optional[str] = Field( None, description='Output only. Server-defined resource path for the target of the operation.', ) verb: Optional[str] = Field( None, description='Output only. Name of the verb executed by the operation.' ) class GoogleCloudManagedidentitiesV1beta1OpMetadata(BaseModel): apiVersion: Optional[str] = Field( None, description='Output only. API version used to start the operation.' ) createTime: Optional[str] = Field( None, description='Output only. The time the operation was created.' ) endTime: Optional[str] = Field( None, description='Output only. The time the operation finished running.' ) requestedCancellation: Optional[bool] = Field( None, description='Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.', ) target: Optional[str] = Field( None, description='Output only. Server-defined resource path for the target of the operation.', ) verb: Optional[str] = Field( None, description='Output only. Name of the verb executed by the operation.' ) class State3(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' CREATING = 'CREATING' READY = 'READY' UPDATING = 'UPDATING' REPAIRING = 'REPAIRING' DELETING = 'DELETING' ERROR = 'ERROR' class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule(BaseModel): canReschedule: Optional[bool] = Field( None, description='This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.', ) endTime: Optional[str] = Field( None, description='The scheduled end time for the maintenance.' ) rolloutManagementPolicy: Optional[str] = Field( None, description='The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.', ) scheduleDeadlineTime: Optional[str] = Field( None, description="schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus maintenance window length (1 day or 1 week). Maintenance cannot be scheduled to start beyond this deadline.", ) startTime: Optional[str] = Field( None, description='The scheduled start time for the maintenance.' ) class GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter(BaseModel): values: Optional[List[str]] = Field( None, description="Optional. Array of string values. e.g. instance's replica information.", ) class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource(BaseModel): resourceType: Optional[str] = Field( None, description="Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'.", ) resourceUrl: Optional[str] = Field( None, description='URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)".', ) class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility(BaseModel): eligible: Optional[bool] = Field( None, description='Whether an instance is eligible or ineligible.' ) reason: Optional[str] = Field( None, description='User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.', ) class State4(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' UPDATING = 'UPDATING' ACTIVE = 'ACTIVE' FAILED = 'FAILED' class LDAPSSettings(BaseModel): certificate: Optional[Certificate] = Field( None, description='Output only. The certificate used to configure LDAPS. Certificates can be chained with a maximum length of 15.', ) certificatePassword: Optional[str] = Field( None, description='Input only. The password used to encrypt the uploaded pfx certificate.', ) certificatePfx: Optional[str] = Field( None, description='Input only. The uploaded PKCS12-formatted certificate to configure LDAPS with. It will enable the domain controllers in this domain to accept LDAPS connections (either LDAP over SSL/TLS or the StartTLS operation). A valid certificate chain must form a valid x.509 certificate chain (or be comprised of a single self-signed certificate. It must be encrypted with either: 1) PBES2 + PBKDF2 + AES256 encryption and SHA256 PRF; or 2) pbeWithSHA1And3-KeyTripleDES-CBC Private key must be included for the leaf / single self-signed certificate. Note: For a fqdn your-example-domain.com, the wildcard fqdn is *.your-example-domain.com. Specifically the leaf certificate must have: - Either a blank subject or a subject with CN matching the wildcard fqdn. - Exactly two SANs - the fqdn and wildcard fqdn. - Encipherment and digital key signature key usages. - Server authentication extended key usage (OID=1.3.6.1.5.5.7.3.1) - Private key must be in one of the following formats: RSA, ECDSA, ED25519. - Private key must have appropriate key length: 2048 for RSA, 256 for ECDSA - Signature algorithm of the leaf certificate cannot be MD2, MD5 or SHA1.', ) name: Optional[str] = Field( None, description='The resource name of the LDAPS settings. Uses the form: `projects/{project}/locations/{location}/domains/{domain}`.', ) state: Optional[State4] = Field( None, description='Output only. The current state of this LDAPS settings.' ) updateTime: Optional[str] = Field( None, description='Output only. Last update time.' ) class ListBackupsResponse(BaseModel): backups: Optional[List[Backup]] = Field( None, description='A list of Cloud AD backups in the domain.' ) nextPageToken: Optional[str] = Field( None, description='Token to retrieve the next page of results, or empty if there are no more results in the list.', ) unreachable: Optional[List[str]] = Field( None, description='Locations that could not be reached.' ) class Location(BaseModel): displayName: Optional[str] = Field( None, description='The friendly name for this location, typically a nearby city name. For example, "Tokyo".', ) labels: Optional[Dict[str, str]] = Field( None, description='Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}', ) locationId: Optional[str] = Field( None, description='The canonical id for this location. For example: `"us-east1"`.', ) metadata: Optional[Dict[str, Any]] = Field( None, description='Service-specific metadata. For example the available capacity at the given location.', ) name: Optional[str] = Field( None, description='Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`', ) class State5(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' READY = 'READY' DELETING = 'DELETING' class OnPremDomainDetails(BaseModel): disableSidFiltering: Optional[bool] = Field( None, description='Optional. Option to disable SID filtering.' ) domainName: Optional[str] = Field( None, description='Required. FQDN of the on-prem domain being migrated.' ) class SidFilteringState(Enum): SID_FILTERING_STATE_UNSPECIFIED = 'SID_FILTERING_STATE_UNSPECIFIED' ENABLED = 'ENABLED' DISABLED = 'DISABLED' class OnPremDomainSIDDetails(BaseModel): name: Optional[str] = Field( None, description='FQDN of the on-prem domain being migrated.' ) sidFilteringState: Optional[SidFilteringState] = Field( None, description='Current SID filtering state.' ) class OperationMetadata(BaseModel): apiVersion: Optional[str] = Field( None, description='Output only. API version used to start the operation.' ) cancelRequested: Optional[bool] = Field( None, description='Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.', ) createTime: Optional[str] = Field( None, description='Output only. The time the operation was created.' ) endTime: Optional[str] = Field( None, description='Output only. The time the operation finished running.' ) statusDetail: Optional[str] = Field( None, description='Output only. Human-readable status of the operation, if any.' ) target: Optional[str] = Field( None, description='Output only. Server-defined resource path for the target of the operation.', ) verb: Optional[str] = Field( None, description='Output only. Name of the verb executed by the operation.' ) class State6(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' CREATING = 'CREATING' CONNECTED = 'CONNECTED' DISCONNECTED = 'DISCONNECTED' DELETING = 'DELETING' class Peering(BaseModel): authorizedNetwork: Optional[str] = Field( None, description='Required. The full names of the Google Compute Engine [networks](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail.', ) createTime: Optional[str] = Field( None, description='Output only. The time the instance was created.' ) domainResource: Optional[str] = Field( None, description='Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: `projects/{project_id}/locations/global/domains/{domain_name}`', ) labels: Optional[Dict[str, str]] = Field( None, description='Optional. Resource labels to represent user provided metadata.', ) name: Optional[str] = Field( None, description='Output only. Unique name of the peering in this scope including projects and location using the form: `projects/{project_id}/locations/global/peerings/{peering_id}`.', ) state: Optional[State6] = Field( None, description='Output only. The current state of this Peering.' ) statusMessage: Optional[str] = Field( None, description='Output only. Additional information about the current status of this peering, if available.', ) updateTime: Optional[str] = Field( None, description='Output only. Last update time.' ) class ResetAdminPasswordRequest(BaseModel): pass class ResetAdminPasswordResponse(BaseModel): password: Optional[str] = Field( None, description='A random password. See admin for more information.' ) class RestoreDomainRequest(BaseModel): backupId: Optional[str] = Field( None, description='Required. ID of the backup to be restored' ) class State7(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' CREATING = 'CREATING' DELETING = 'DELETING' READY = 'READY' class SQLIntegration(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The time the instance was created.' ) name: Optional[str] = Field( None, description='The unique name of the sql integration in the form of `projects/{project_id}/locations/global/domains/{domain_name}/sqlIntegrations/{sql_integration}`', ) sqlInstance: Optional[str] = Field( None, description='The full resource name of an integrated sql instance' ) state: Optional[State7] = Field( None, description='Output only. The current state of the managed OU.' ) updateTime: Optional[str] = Field( None, description='Output only. Last update time for this SQL instance.' ) class Day(Enum): DAY_OF_WEEK_UNSPECIFIED = 'DAY_OF_WEEK_UNSPECIFIED' MONDAY = 'MONDAY' TUESDAY = 'TUESDAY' WEDNESDAY = 'WEDNESDAY' THURSDAY = 'THURSDAY' FRIDAY = 'FRIDAY' SATURDAY = 'SATURDAY' SUNDAY = 'SUNDAY' class Status(BaseModel): code: Optional[int] = Field( None, description='The status code, which should be an enum value of google.rpc.Code.', ) details: Optional[List[Dict[str, Any]]] = Field( None, description='A list of messages that carry the error details. There is a common set of message types for APIs to use.', ) message: Optional[str] = Field( None, description='A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.', ) class TestIamPermissionsRequest(BaseModel): permissions: Optional[List[str]] = Field( None, description='The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).', ) class TestIamPermissionsResponse(BaseModel): permissions: Optional[List[str]] = Field( None, description='A subset of `TestPermissionsRequest.permissions` that the caller is allowed.', ) class TimeOfDay(BaseModel): hours: Optional[int] = Field( None, description='Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.', ) minutes: Optional[int] = Field( None, description='Minutes of hour of day. Must be from 0 to 59.' ) nanos: Optional[int] = Field( None, description='Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.', ) seconds: Optional[int] = Field( None, description='Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.', ) class State8(Enum): STATE_UNSPECIFIED = 'STATE_UNSPECIFIED' CREATING = 'CREATING' UPDATING = 'UPDATING' DELETING = 'DELETING' CONNECTED = 'CONNECTED' DISCONNECTED = 'DISCONNECTED' class TrustDirection(Enum): TRUST_DIRECTION_UNSPECIFIED = 'TRUST_DIRECTION_UNSPECIFIED' INBOUND = 'INBOUND' OUTBOUND = 'OUTBOUND' BIDIRECTIONAL = 'BIDIRECTIONAL' class TrustType(Enum): TRUST_TYPE_UNSPECIFIED = 'TRUST_TYPE_UNSPECIFIED' FOREST = 'FOREST' EXTERNAL = 'EXTERNAL' class Trust(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The time the instance was created.' ) lastKnownTrustConnectedHeartbeatTime: Optional[str] = Field( None, description='Output only. The last heartbeat time when the trust was known to be connected.', ) selectiveAuthentication: Optional[bool] = Field( None, description='The trust authentication type which decides whether the trusted side has forest/domain wide access or selective access to approved set of resources.', ) state: Optional[State8] = Field( None, description='Output only. The current state of this trust.' ) stateDescription: Optional[str] = Field( None, description='Output only. Additional information about the current state of this trust, if available.', ) targetDnsIpAddresses: Optional[List[str]] = Field( None, description='The target dns server ip addresses which can resolve the remote domain involved in trust.', ) targetDomainName: Optional[str] = Field( None, description='The fully qualified target domain name which will be in trust with current domain.', ) trustDirection: Optional[TrustDirection] = Field( None, description='The trust direction decides the current domain is trusted, trusting or both.', ) trustHandshakeSecret: Optional[str] = Field( None, description='Input only, and will not be stored. The trust secret used for handshake with target domain.', ) trustType: Optional[TrustType] = Field( None, description='The type of trust represented by the trust resource.' ) updateTime: Optional[str] = Field( None, description='Output only. Last update time.' ) class Channel(Enum): UPDATE_CHANNEL_UNSPECIFIED = 'UPDATE_CHANNEL_UNSPECIFIED' EARLIER = 'EARLIER' LATER = 'LATER' WEEK1 = 'WEEK1' WEEK2 = 'WEEK2' WEEK5 = 'WEEK5' class ValidateTrustRequest(BaseModel): trust: Optional[Trust] = Field( None, description='The domain trust to validate trust state for.' ) class FieldXgafv(Enum): field_1 = '1' field_2 = '2' class Alt(Enum): json = 'json' media = 'media' proto = 'proto' class AttachTrustRequest(BaseModel): trust: Optional[Trust] = Field(None, description='The domain trust resource.') class Binding(BaseModel): condition: Optional[Expr] = Field( None, description='The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).', ) members: Optional[List[str]] = Field( None, description='Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.', ) role: Optional[str] = Field( None, description='Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.', ) class CheckMigrationPermissionResponse(BaseModel): onpremDomains: Optional[List[OnPremDomainSIDDetails]] = Field( None, description='The state of SID filtering of all the domains which has trust established.', ) state: Optional[State1] = Field(None, description='The state of DomainMigration.') class DailyCycle(BaseModel): duration: Optional[str] = Field( None, description='Output only. Duration of the time window, set by service producer.', ) startTime: Optional[TimeOfDay] = Field( None, description='Time within the day to start the operations.' ) class DenyMaintenancePeriod(BaseModel): endDate: Optional[Date] = Field( None, description='Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end.', ) startDate: Optional[Date] = Field( None, description='Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start.', ) time: Optional[TimeOfDay] = Field( None, description='Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC', ) class DetachTrustRequest(BaseModel): trust: Optional[Trust] = Field( None, description='The domain trust resource to removed.' ) class Domain(BaseModel): auditLogsEnabled: Optional[bool] = Field( None, description='Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.', ) authorizedNetworks: Optional[List[str]] = Field( None, description='Optional. The full names of the Google Compute Engine [networks](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. Network can be added using UpdateDomain later. Domain is only available on network part of authorized_networks. Caller needs to make sure that CIDR subnets do not overlap between networks, else domain creation will fail.', ) createTime: Optional[str] = Field( None, description='Output only. The time the instance was created. Synthetic field is populated automatically by CCFE. go/ccfe-synthetic-field-user-guide', ) fqdn: Optional[str] = Field( None, description='Output only. Fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory that is set up on an internal network.', ) labels: Optional[Dict[str, str]] = Field( None, description='Optional. Resource labels to represent user provided metadata', ) locations: Optional[List[str]] = Field( None, description='Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.', ) managedIdentitiesAdminName: Optional[str] = Field( None, description='Optional. Name of customer-visible admin used to perform Active Directory operations. If not specified `setupadmin` would be used.', ) name: Optional[str] = Field( None, description='Output only. Unique name of the domain in this scope including projects and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}`.', ) reservedIpRange: Optional[str] = Field( None, description='Required. The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorized_networks].', ) state: Optional[State2] = Field( None, description='Output only. The current state of this domain.' ) statusMessage: Optional[str] = Field( None, description='Output only. Additional information about the current status of this domain, if available.', ) trusts: Optional[List[Trust]] = Field( None, description='Output only. The current trusts associated with the domain.' ) updateTime: Optional[str] = Field( None, description='Output only. Last update time. Synthetic field is populated automatically by CCFE.', ) class EnableMigrationRequest(BaseModel): migratingDomains: Optional[List[OnPremDomainDetails]] = Field( None, description='Required. List of the on-prem domains to be migrated.' ) class GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility(BaseModel): eligibilities: Optional[ Dict[str, GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] ] = Field( None, description='An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.', ) class ListDomainsResponse(BaseModel): domains: Optional[List[Domain]] = Field( None, description='A list of Managed Identities Service domains in the project.' ) nextPageToken: Optional[str] = Field( None, description='Token to retrieve the next page of results, or empty if there are no more results in the list.', ) unreachable: Optional[List[str]] = Field( None, description='Locations that could not be reached.' ) class ListLocationsResponse(BaseModel): locations: Optional[List[Location]] = Field( None, description='A list of locations that matches the specified filter in the request.', ) nextPageToken: Optional[str] = Field( None, description='The standard List next-page token.' ) class ListPeeringsResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='Token to retrieve the next page of results, or empty if there are no more results in the list.', ) peerings: Optional[List[Peering]] = Field( None, description='A list of Managed Identities Service Peerings in the project.', ) unreachable: Optional[List[str]] = Field( None, description='Locations that could not be reached.' ) class ListSQLIntegrationsResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='Token to retrieve the next page of results, or empty if there are no more results in the list.', ) sqlIntegrations: Optional[List[SQLIntegration]] = Field( None, description='A list of SQLIntegrations of a domain.' ) unreachable: Optional[List[str]] = Field( None, description='A list of locations that could not be reached.' ) class Operation(BaseModel): done: Optional[bool] = Field( None, description='If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.', ) error: Optional[Status] = Field( None, description='The error result of the operation in case of failure or cancellation.', ) metadata: Optional[Dict[str, Any]] = Field( None, description='Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.', ) name: Optional[str] = Field( None, description='The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.', ) response: Optional[Dict[str, Any]] = Field( None, description='The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.', ) class Policy(BaseModel): bindings: Optional[List[Binding]] = Field( None, description='Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.', ) etag: Optional[str] = Field( None, description='`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.', ) version: Optional[int] = Field( None, description='Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).', ) class ReconfigureTrustRequest(BaseModel): trust: Optional[Trust] = Field( None, description='The domain trust resource with updated dns conditional forwarder.', ) class Schedule(BaseModel): day: Optional[Day] = Field( None, description='Allows to define schedule that runs specified day of the week.', ) duration: Optional[str] = Field( None, description='Output only. Duration of the time window, set by service producer.', ) startTime: Optional[TimeOfDay] = Field( None, description='Time within the window to start the operations.' ) class SetIamPolicyRequest(BaseModel): policy: Optional[Policy] = Field( None, description='REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.', ) class WeeklyCycle(BaseModel): schedule: Optional[List[Schedule]] = Field( None, description='User can specify multiple windows in a week. Minimum of 1 window.', ) class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata(BaseModel): location: Optional[str] = Field( None, description='The location of the node, if different from instance location.', ) nodeId: Optional[str] = Field( None, description='The id of the node. This should be equal to SaasInstanceNode.node_id.', ) perSliEligibility: Optional[ GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility ] = Field( None, description='If present, this will override eligibility for the node coming from instance or exclusions for specified SLIs.', ) class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata(BaseModel): nodes: Optional[ List[GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata] ] = Field( None, description='Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch.', ) perSliEligibility: Optional[ GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility ] = Field( None, description='Optional. Multiple per-instance SLI eligibilities which apply for individual SLIs.', ) tier: Optional[str] = Field( None, description='Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty.', ) class ListOperationsResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='The standard List next-page token.' ) operations: Optional[List[Operation]] = Field( None, description='A list of operations that matches the specified filter in the request.', ) class MaintenanceWindow(BaseModel): dailyCycle: Optional[DailyCycle] = Field(None, description='Daily cycle.') weeklyCycle: Optional[WeeklyCycle] = Field(None, description='Weekly cycle.') class UpdatePolicy(BaseModel): channel: Optional[Channel] = Field( None, description='Optional. Relative scheduling channel applied to resource.' ) denyMaintenancePeriods: Optional[List[DenyMaintenancePeriod]] = Field( None, description='Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. User can specify zero or more non-overlapping deny periods. Maximum number of deny_maintenance_periods expected is one.', ) window: Optional[MaintenanceWindow] = Field( None, description='Optional. Maintenance window that is applied to resources covered by this policy.', ) class MaintenancePolicy(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The time when the resource was created.' ) description: Optional[str] = Field( None, description='Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.', ) labels: Optional[Dict[str, str]] = Field( None, description='Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.', ) name: Optional[str] = Field( None, description='Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.', ) state: Optional[State5] = Field( None, description='Optional. The state of the policy.' ) updatePolicy: Optional[UpdatePolicy] = Field( None, description='Maintenance policy applicable to instance update.' ) updateTime: Optional[str] = Field( None, description='Output only. The time when the resource was updated.' ) class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings(BaseModel): exclude: Optional[bool] = Field( None, description='Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.', ) isRollback: Optional[bool] = Field( None, description='Optional. If the update call is triggered from rollback, set the value as true.', ) maintenancePolicies: Optional[Dict[str, MaintenancePolicy]] = Field( None, description='Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For details, please refer to go/cloud-saas-mw-ug. Should not be set if maintenance_policy_names is set. If only the name is needed, then only populate MaintenancePolicy.name.', ) class GoogleCloudSaasacceleratorManagementProvidersV1Instance(BaseModel): consumerDefinedName: Optional[str] = Field( None, description='consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).', ) createTime: Optional[str] = Field( None, description='Output only. Timestamp when the resource was created.' ) instanceType: Optional[str] = Field( None, description="Optional. The instance_type of this instance of format: projects/{project_number}/locations/{location_id}/instanceTypes/{instance_type_id}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not.", ) labels: Optional[Dict[str, str]] = Field( None, description='Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.', ) maintenancePolicyNames: Optional[Dict[str, str]] = Field( None, description='Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For details, please refer to go/cloud-saas-mw-ug. Should not be set if maintenance_settings.maintenance_policies is set.', ) maintenanceSchedules: Optional[ Dict[str, GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule] ] = Field( None, description='The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.', ) maintenanceSettings: Optional[ GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings ] = Field( None, description='Optional. The MaintenanceSettings associated with instance.' ) name: Optional[str] = Field( None, description='Unique name of the resource. It uses the form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details.', ) notificationParameters: Optional[ Dict[str, GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter] ] = Field( None, description='Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose.', ) producerMetadata: Optional[Dict[str, str]] = Field( None, description='Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.', ) provisionedResources: Optional[ List[GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource] ] = Field( None, description='Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.', ) slmInstanceTemplate: Optional[str] = Field( None, description="Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.", ) sloMetadata: Optional[ GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata ] = Field( None, description='Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.', ) softwareVersions: Optional[Dict[str, str]] = Field( None, description='Software versions that are used to deploy this instance. This can be mutated by rollout services.', ) state: Optional[State3] = Field( None, description="Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).", ) tenantProjectId: Optional[str] = Field( None, description='Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.', ) updateTime: Optional[str] = Field( None, description='Output only. Timestamp when the resource was last modified.' ) Certificate.model_rebuild()