Close httplib2 connections.
dismiss(name, body=None, x__xgafv=None)
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
+Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
Gets an approval request. Returns NOT_FOUND if the request does not exist.
invalidate(name, body=None, x__xgafv=None)
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
+Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
@@ -138,18 +138,18 @@dismiss(name, body=None, x__xgafv=None)
- Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. +Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. Args: name: string, Name of the ApprovalRequest to dismiss. (required) @@ -204,18 +204,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -259,18 +259,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -281,7 +281,7 @@Method Details
@@ -1920,13 +1921,14 @@invalidate(name, body=None, x__xgafv=None)-Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. +Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. Args: name: string, Name of the ApprovalRequest to invalidate. (required) @@ -320,18 +320,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -380,18 +380,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. diff --git a/docs/dyn/accessapproval_v1.folders.html b/docs/dyn/accessapproval_v1.folders.html index 66ad29a504..9beeacc5cf 100644 --- a/docs/dyn/accessapproval_v1.folders.html +++ b/docs/dyn/accessapproval_v1.folders.html @@ -84,10 +84,10 @@Instance Methods
Close httplib2 connections.
-
deleteAccessApprovalSettings(name, x__xgafv=None)Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
+Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
-
getAccessApprovalSettings(name, x__xgafv=None)Gets the settings associated with a project, folder, or organization.
+Gets the Access Approval settings associated with a project, folder, or organization.
getServiceAccount(name, x__xgafv=None)Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
@@ -102,7 +102,7 @@Method Details
diff --git a/docs/dyn/accessapproval_v1.organizations.approvalRequests.html b/docs/dyn/accessapproval_v1.organizations.approvalRequests.html index 238b94f119..8dc3699422 100644 --- a/docs/dyn/accessapproval_v1.organizations.approvalRequests.html +++ b/docs/dyn/accessapproval_v1.organizations.approvalRequests.html @@ -82,13 +82,13 @@deleteAccessApprovalSettings(name, x__xgafv=None)-Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. +Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled. Args: name: string, Name of the AccessApprovalSettings to delete. (required) @@ -120,7 +120,7 @@Method Details
@@ -193,16 +193,16 @@getAccessApprovalSettings(name, x__xgafv=None)-Gets the settings associated with a project, folder, or organization. +Gets the Access Approval settings associated with a project, folder, or organization. Args: name: string, The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings" (required) @@ -135,16 +135,16 @@Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -153,11 +153,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" }Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -211,11 +211,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" } updateMask: string, The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. @@ -230,16 +230,16 @@Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -248,11 +248,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" }Instance Methods
Close httplib2 connections.
-
dismiss(name, body=None, x__xgafv=None)Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
+Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
Gets an approval request. Returns NOT_FOUND if the request does not exist.
-
invalidate(name, body=None, x__xgafv=None)Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
+Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
@@ -138,18 +138,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -165,7 +165,7 @@Method Details
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html new file mode 100644 index 0000000000..6f0fcfbb47 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html @@ -0,0 +1,131 @@ + + + +dismiss(name, body=None, x__xgafv=None)-Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. +Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. Args: name: string, Name of the ApprovalRequest to dismiss. (required) @@ -204,18 +204,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -259,18 +259,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -281,7 +281,7 @@Method Details
@@ -4112,13 +4128,14 @@invalidate(name, body=None, x__xgafv=None)-Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. +Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. Args: name: string, Name of the ApprovalRequest to invalidate. (required) @@ -320,18 +320,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -380,18 +380,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. diff --git a/docs/dyn/accessapproval_v1.organizations.html b/docs/dyn/accessapproval_v1.organizations.html index e808599256..7c0149972a 100644 --- a/docs/dyn/accessapproval_v1.organizations.html +++ b/docs/dyn/accessapproval_v1.organizations.html @@ -84,10 +84,10 @@Instance Methods
Close httplib2 connections.
-
deleteAccessApprovalSettings(name, x__xgafv=None)Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
+Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
-
getAccessApprovalSettings(name, x__xgafv=None)Gets the settings associated with a project, folder, or organization.
+Gets the Access Approval settings associated with a project, folder, or organization.
getServiceAccount(name, x__xgafv=None)Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
@@ -102,7 +102,7 @@Method Details
diff --git a/docs/dyn/accessapproval_v1.projects.approvalRequests.html b/docs/dyn/accessapproval_v1.projects.approvalRequests.html index 5ae7f1ec70..7e4153626b 100644 --- a/docs/dyn/accessapproval_v1.projects.approvalRequests.html +++ b/docs/dyn/accessapproval_v1.projects.approvalRequests.html @@ -82,13 +82,13 @@deleteAccessApprovalSettings(name, x__xgafv=None)-Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. +Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled. Args: name: string, Name of the AccessApprovalSettings to delete. (required) @@ -120,7 +120,7 @@Method Details
@@ -193,16 +193,16 @@getAccessApprovalSettings(name, x__xgafv=None)-Gets the settings associated with a project, folder, or organization. +Gets the Access Approval settings associated with a project, folder, or organization. Args: name: string, The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings" (required) @@ -135,16 +135,16 @@Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -153,11 +153,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" }Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -211,11 +211,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" } updateMask: string, The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. @@ -230,16 +230,16 @@Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -248,11 +248,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" }Instance Methods
Close httplib2 connections.
-
dismiss(name, body=None, x__xgafv=None)Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
+Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
Gets an approval request. Returns NOT_FOUND if the request does not exist.
-
invalidate(name, body=None, x__xgafv=None)Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
+Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
@@ -138,18 +138,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -165,7 +165,7 @@Method Details
diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 1a343de469..41d0c92487 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -322,13 +322,14 @@dismiss(name, body=None, x__xgafv=None)-Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. +Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. Args: name: string, Name of the ApprovalRequest to dismiss. (required) @@ -204,18 +204,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -259,18 +259,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -281,7 +281,7 @@Method Details
@@ -1688,13 +1689,14 @@invalidate(name, body=None, x__xgafv=None)-Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. +Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. Args: name: string, Name of the ApprovalRequest to invalidate. (required) @@ -320,18 +320,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. @@ -380,18 +380,18 @@Method Details
}, "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". "requestTime": "A String", # The time at which approval was requested. - "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request. + "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request. "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks). }, "requestedDuration": "A String", # The requested access duration. "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. - "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. - "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location - "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested. + "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location + "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location }, - "requestedReason": { # The justification for which approval is being requested. + "requestedReason": { # The access reason for which approval is being requested. "detail": "A String", # More detail about certain reason types. See comments for each type above. - "type": "A String", # Type of access justification. + "type": "A String", # Type of access reason. }, "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. diff --git a/docs/dyn/accessapproval_v1.projects.html b/docs/dyn/accessapproval_v1.projects.html index 0177539516..9002cca121 100644 --- a/docs/dyn/accessapproval_v1.projects.html +++ b/docs/dyn/accessapproval_v1.projects.html @@ -84,10 +84,10 @@Instance Methods
Close httplib2 connections.
-
deleteAccessApprovalSettings(name, x__xgafv=None)Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
+Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
-
getAccessApprovalSettings(name, x__xgafv=None)Gets the settings associated with a project, folder, or organization.
+Gets the Access Approval settings associated with a project, folder, or organization.
getServiceAccount(name, x__xgafv=None)Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
@@ -102,7 +102,7 @@Method Details
diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html index 98b9e5f644..1a4ba19747 100644 --- a/docs/dyn/admin_directory_v1.chromeosdevices.html +++ b/docs/dyn/admin_directory_v1.chromeosdevices.html @@ -267,7 +267,7 @@deleteAccessApprovalSettings(name, x__xgafv=None)-Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. +Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled. Args: name: string, Name of the AccessApprovalSettings to delete. (required) @@ -120,7 +120,7 @@Method Details
@@ -193,16 +193,16 @@getAccessApprovalSettings(name, x__xgafv=None)-Gets the settings associated with a project, folder, or organization. +Gets the Access Approval settings associated with a project, folder, or organization. Args: name: string, The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings" (required) @@ -135,16 +135,16 @@Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -153,11 +153,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" }Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -211,11 +211,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" } updateMask: string, The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. @@ -230,16 +230,16 @@Method Details
{ # Settings on a Project/Folder/Organization related to Access Approval. "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). - "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies. + "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, - "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field. + "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance. "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given. }, "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). - "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. { # Represents the enrollment of a cloud resource into a specific service. - "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services + "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services "enrollmentLevel": "A String", # The enrollment level of the service. }, ], @@ -248,11 +248,11 @@Method Details
"notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. "A String", ], - "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent. - "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. - "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. - "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request. - "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible. + "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses. + "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level. + "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days. + "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope. + "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification" }Method Details
"updateTime": "A String", # Date and time of the last successful OS update. }, "osVersion": "A String", # The Chrome device's operating system version. - "osVersionCompliance": "A String", # Output only. Compliance status of the OS version. + "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version. "platformVersion": "A String", # The Chrome device's platform version. "recentUsers": [ # A list of recent device users, in descending order, by last login time. { # A list of recent device users, in descending order, by last login time. @@ -466,7 +466,7 @@Method Details
"updateTime": "A String", # Date and time of the last successful OS update. }, "osVersion": "A String", # The Chrome device's operating system version. - "osVersionCompliance": "A String", # Output only. Compliance status of the OS version. + "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version. "platformVersion": "A String", # The Chrome device's platform version. "recentUsers": [ # A list of recent device users, in descending order, by last login time. { # A list of recent device users, in descending order, by last login time. @@ -680,7 +680,7 @@Method Details
"updateTime": "A String", # Date and time of the last successful OS update. }, "osVersion": "A String", # The Chrome device's operating system version. - "osVersionCompliance": "A String", # Output only. Compliance status of the OS version. + "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version. "platformVersion": "A String", # The Chrome device's platform version. "recentUsers": [ # A list of recent device users, in descending order, by last login time. { # A list of recent device users, in descending order, by last login time. @@ -853,7 +853,7 @@Method Details
"updateTime": "A String", # Date and time of the last successful OS update. }, "osVersion": "A String", # The Chrome device's operating system version. - "osVersionCompliance": "A String", # Output only. Compliance status of the OS version. + "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version. "platformVersion": "A String", # The Chrome device's platform version. "recentUsers": [ # A list of recent device users, in descending order, by last login time. { # A list of recent device users, in descending order, by last login time. @@ -1025,7 +1025,7 @@Method Details
"updateTime": "A String", # Date and time of the last successful OS update. }, "osVersion": "A String", # The Chrome device's operating system version. - "osVersionCompliance": "A String", # Output only. Compliance status of the OS version. + "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version. "platformVersion": "A String", # The Chrome device's platform version. "recentUsers": [ # A list of recent device users, in descending order, by last login time. { # A list of recent device users, in descending order, by last login time. @@ -1198,7 +1198,7 @@Method Details
"updateTime": "A String", # Date and time of the last successful OS update. }, "osVersion": "A String", # The Chrome device's operating system version. - "osVersionCompliance": "A String", # Output only. Compliance status of the OS version. + "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version. "platformVersion": "A String", # The Chrome device's platform version. "recentUsers": [ # A list of recent device users, in descending order, by last login time. { # A list of recent device users, in descending order, by last login time. diff --git a/docs/dyn/admin_directory_v1.groups.html b/docs/dyn/admin_directory_v1.groups.html index 6bbba94b01..c16965f676 100644 --- a/docs/dyn/admin_directory_v1.groups.html +++ b/docs/dyn/admin_directory_v1.groups.html @@ -217,7 +217,7 @@Method Details
Allowed values email - Email of the group. pageToken: string, Token to specify next page in the list - query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups + query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used Allowed values ASCENDING - Ascending order. diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index 62dd8f2b75..ce8adf1701 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -880,7 +880,7 @@Method Details
basic - Do not include any custom fields for the user. custom - Include custom fields from schemas mentioned in customFieldMask. full - Include all fields associated with this user. - query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users + query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users showDeleted: string, If set to true, retrieves the list of deleted users. (Default: false) sortOrder: string, Whether to return results in ascending or descending order. Allowed values diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 27c29ce8d2..07021899ba 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -479,13 +479,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -952,13 +953,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1134,25 +1136,18 @@Method Details
{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1197,6 +1192,12 @@Method Details
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1245,10 +1246,10 @@Method Details
], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1261,38 +1262,38 @@Method Details
], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1870,25 +1872,18 @@Method Details
{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1933,6 +1928,12 @@Method Details
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1981,10 +1982,10 @@Method Details
], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1997,38 +1998,38 @@Method Details
], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -652,13 +653,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1007,13 +1009,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1348,13 +1351,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1697,13 +1701,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2028,13 +2033,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html new file mode 100644 index 0000000000..0a9efff18e --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html @@ -0,0 +1,91 @@ + + + +Vertex AI API . projects . locations . endpoints . deployedModels
+Instance Methods
++
+invoke()+Returns the invoke Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html new file mode 100644 index 0000000000..e395e04b7f --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html @@ -0,0 +1,132 @@ + + + +close()+Close httplib2 connections.+Vertex AI API . projects . locations . endpoints . deployedModels . invoke
+Instance Methods
++
+close()Close httplib2 connections.
++
+invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None)Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index edcfb1cb07..a74c9f3d33 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -79,6 +79,21 @@invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None)+Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + +Args: + endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required) + deployedModelId: string, ID of the DeployedModel that serves the invoke request. (required) + invokeId: string, A parameter (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for PredictionService.Invoke. + "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request. + "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload. + "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. + "data": "A String", # The HTTP request/response body as raw binary. + "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. + "data": "A String", # The HTTP request/response body as raw binary. + "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], +}+Instance Methods
Returns the chat Resource.
++
+deployedModels()+Returns the deployedModels Resource.
+ ++
+invoke()+Returns the invoke Resource.
+ ++
+openapi()+Returns the openapi Resource.
+ @@ -532,13 +547,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1899,13 +1915,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2081,25 +2098,18 @@Method Details
{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2144,6 +2154,12 @@Method Details
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2192,10 +2208,10 @@Method Details
], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2208,38 +2224,38 @@Method Details
], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -4294,25 +4311,18 @@Method Details
{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -4357,6 +4367,12 @@Method Details
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -4405,10 +4421,10 @@Method Details
], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -4421,38 +4437,38 @@Method Details
], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }Vertex AI API . projects . locations . endpoints . invoke
+Instance Methods
++
+close()Close httplib2 connections.
++
+invoke(endpoint, invokeId, body=None, x__xgafv=None)Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html new file mode 100644 index 0000000000..afb9044642 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html @@ -0,0 +1,128 @@ + + + +invoke(endpoint, invokeId, body=None, x__xgafv=None)+Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + +Args: + endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required) + invokeId: string, A parameter (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for PredictionService.Invoke. + "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request. + "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload. + "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. + "data": "A String", # The HTTP request/response body as raw binary. + "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. + "data": "A String", # The HTTP request/response body as raw binary. + "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], +}+Vertex AI API . projects . locations . endpoints . openapi
+Instance Methods
++
+close()Close httplib2 connections.
++
+embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 0be2d2ff60..5dc12113c6 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -252,12 +252,6 @@embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)+Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + +Args: + endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required) + body: object, The request body. + The object takes the form of: + +{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. + "data": "A String", # The HTTP request/response body as raw binary. + "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], +} + + deployedModelId: string, ID of the DeployedModel that serves the invoke request. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. + "data": "A String", # The HTTP request/response body as raw binary. + "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], +}+Method Details
}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -1006,12 +1000,6 @@Method Details
}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -1802,12 +1790,6 @@Method Details
}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -2569,12 +2551,6 @@Method Details
}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index e1324fb929..417a3f081b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -616,10 +616,27 @@Method Details
}, }, "endpointConfig": { # The endpoint config to use for the deployment. # Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used. - "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. + "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. "dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. "endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used. "endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect. + "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. + "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. + "A String", + ], + "pscAutomationConfigs": [ # Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only. + { # PSC config that is used to automatically create PSC endpoints in the user projects. + "errorMessage": "A String", # Output only. Error message if the PSC service automation failed. + "forwardingRule": "A String", # Output only. Forwarding rule created by the PSC service automation. + "ipAddress": "A String", # Output only. IP address rule created by the PSC service automation. + "network": "A String", # Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`. + "projectId": "A String", # Required. Project id used to create forwarding rule. + "state": "A String", # Output only. The state of the PSC service automation. + }, + ], + "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. + }, }, "huggingFaceModelId": "A String", # The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`. "modelConfig": { # The model config to use for the deployment. # Optional. The model config to use for the deployment. If not specified, the default model config will be used. @@ -822,6 +839,37 @@Method Details
}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -1211,6 +1259,37 @@Method Details
}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -2247,7 +2326,7 @@Method Details
Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) 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: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index ca388308b3..cc1f519318 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -483,13 +483,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -956,13 +957,14 @@Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1138,25 +1140,18 @@Method Details
{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1201,6 +1196,12 @@Method Details
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1249,10 +1250,10 @@Method Details
], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1265,38 +1266,38 @@Method Details
], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }Method Details
}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2102,25 +2104,18 @@Method Details
{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2165,6 +2160,12 @@Method Details
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2213,10 +2214,10 @@Method Details
], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2229,38 +2230,38 @@Method Details
], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, }
Returns the modelGardenEula Resource.
+
+ publishers()
+
Returns the publishers Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 406c76c156..162ba524d3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -326,13 +326,14 @@
+ invoke()
+
Returns the invoke Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None)
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+close()
+ Close httplib2 connections.+
invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None)
+ Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+ endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+ deployedModelId: string, ID of the DeployedModel that serves the invoke request. (required)
+ invokeId: string, A parameter (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+ "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+ "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+Returns the chat Resource.
+
+ deployedModels()
+
Returns the deployedModels Resource.
+ +
+ invoke()
+
Returns the invoke Resource.
+ +
+ openapi()
+
Returns the openapi Resource.
+ @@ -550,13 +565,14 @@
+ close()
Close httplib2 connections.
+
+ invoke(endpoint, invokeId, body=None, x__xgafv=None)
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+close()
+ Close httplib2 connections.+
invoke(endpoint, invokeId, body=None, x__xgafv=None)
+ Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+ endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+ invokeId: string, A parameter (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+ "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+ "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+close()
+ Close httplib2 connections.+
embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)
+ Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+ endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ v1()
+
Returns the v1 Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ message()
+
Returns the message Resource.
+ +
+ tasks()
+
Returns the tasks Resource.
+ +
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)
Get request for reasoning engine instance via the A2A get protocol apis.
+
+ close()
Close httplib2 connections.
+card(name, a2aEndpoint, historyLength=None, x__xgafv=None)
+ Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+ historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ send(name, a2aEndpoint, body=None, x__xgafv=None)
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+ stream(name, a2aEndpoint, body=None, x__xgafv=None)
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+close()
+ Close httplib2 connections.+
send(name, a2aEndpoint, body=None, x__xgafv=None)
+ Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+ body: object, The request body.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+stream(name, a2aEndpoint, body=None, x__xgafv=None)
+ Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+ body: object, The request body.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+Returns the pushNotificationConfigs Resource.
+ +
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
Get request for reasoning engine instance via the A2A get protocol apis.
+
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+ close()
Close httplib2 connections.
+
+ subscribe(name, a2aEndpoint, x__xgafv=None)
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
+ Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+ historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+cancel(name, a2aEndpoint, body=None, x__xgafv=None)
+ Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+ body: object, The request body.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+close()
+ Close httplib2 connections.+
subscribe(name, a2aEndpoint, x__xgafv=None)
+ Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
Get request for reasoning engine instance via the A2A get protocol apis.
+
+ close()
Close httplib2 connections.
+a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
+ Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+ historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+close()
+ Close httplib2 connections.+
+ a2a()
+
Returns the a2a Resource.
+ @@ -204,6 +209,12 @@
+ models()
+
Returns the models Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ enableModel(parent, name, body=None, x__xgafv=None)
Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).
+close()
+ Close httplib2 connections.+
enableModel(parent, name, body=None, x__xgafv=None)
+ Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).
+
+Args:
+ parent: string, Required. The project requesting access for named model. Format: `projects/{project}` (required)
+ name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ModelGardenService.EnableModel.
+ "service": "A String", # Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ModelGardenService.EnableModel.
+ "enablementState": "A String", # Output only. The result of the model enablement.
+ "publisherEndpoint": "A String", # Output only. The publisher endpoint that the project is enabled for. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`
+}
+
+ v1()
+
Returns the v1 Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ message()
+
Returns the message Resource.
+ +
+ tasks()
+
Returns the tasks Resource.
+ +
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)
Get request for reasoning engine instance via the A2A get protocol apis.
+
+ close()
Close httplib2 connections.
+card(name, a2aEndpoint, historyLength=None, x__xgafv=None)
+ Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+ historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ send(name, a2aEndpoint, body=None, x__xgafv=None)
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+ stream(name, a2aEndpoint, body=None, x__xgafv=None)
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+close()
+ Close httplib2 connections.+
send(name, a2aEndpoint, body=None, x__xgafv=None)
+ Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+ body: object, The request body.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+stream(name, a2aEndpoint, body=None, x__xgafv=None)
+ Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+ body: object, The request body.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+Returns the pushNotificationConfigs Resource.
+ +
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
Get request for reasoning engine instance via the A2A get protocol apis.
+
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+ close()
Close httplib2 connections.
+
+ subscribe(name, a2aEndpoint, x__xgafv=None)
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
+ Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+ historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+cancel(name, a2aEndpoint, body=None, x__xgafv=None)
+ Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+ body: object, The request body.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+close()
+ Close httplib2 connections.+
subscribe(name, a2aEndpoint, x__xgafv=None)
+ Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
Get request for reasoning engine instance via the A2A get protocol apis.
+
+ close()
Close httplib2 connections.
+a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)
+ Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+ name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+ a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+ historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "a_key": "", # Properties of the object.
+}
+close()
+ Close httplib2 connections.+
+ a2a()
+
Returns the a2a Resource.
+ @@ -188,6 +193,12 @@close()
Close httplib2 connections.
+get(name, view=None, x__xgafv=None)
Gets a requested Account resource.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
get(name, x__xgafv=None)
+ get(name, view=None, x__xgafv=None)
Gets a requested Account resource.
Args:
name: string, Required. The name of the account to retrieve. (required)
+ view: string, Optional. What information to include in the response.
+ Allowed values
+ ACCOUNT_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view for ListAccounts. For GetAccount it will default to the FULL view.
+ ACCOUNT_VIEW_BASIC - Include base account information. This is the default view.
+ ACCOUNT_VIEW_FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -159,6 +164,7 @@ Method Details
},
"name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
"provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+ "resellerParentBillingAccount": "A String", # The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}
"state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
"updateTime": "A String", # Output only. The last update timestamp.
}
@@ -197,6 +203,7 @@ list_next()
Retrieves the next page of results.
-Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
+lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)
+Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
Retrieves the next page of results.
@@ -362,14 +362,16 @@lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)
- Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. +lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)+Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. Args: parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required) androidId: string, Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). + iosDeviceId: string, Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps. pageSize: integer, The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. pageToken: string, A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token. + partner: string, Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps. rawResourceId: string, Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json userId: string, The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user. x__xgafv: string, V1 error format. diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index 1c1ae25c76..8ebcc7e9a4 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -79,7 +79,7 @@Instance Methods
Close httplib2 connections.
-
getAutokeyConfig(name, x__xgafv=None)Returns the AutokeyConfig for a folder.
+Returns the AutokeyConfig for a folder or project.
getKajPolicyConfig(name, x__xgafv=None)Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
@@ -97,10 +97,10 @@Method Details
+getAutokeyConfig(name, x__xgafv=None)-Returns the AutokeyConfig for a folder. +Returns the AutokeyConfig for a folder or project. Args: - name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. (required) + name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html index 22142553a7..a5fe282dad 100644 --- a/docs/dyn/cloudkms_v1.projects.html +++ b/docs/dyn/cloudkms_v1.projects.html @@ -82,6 +82,9 @@Instance Methods
Close httplib2 connections.
++
+getAutokeyConfig(name, x__xgafv=None)Returns the AutokeyConfig for a folder or project.
getKajPolicyConfig(name, x__xgafv=None)Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
@@ -94,6 +97,9 @@Instance Methods
showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.
++
+updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
@@ -103,6 +109,28 @@Method Details
Close httplib2 connections.++getAutokeyConfig(name, x__xgafv=None)+Returns the AutokeyConfig for a folder or project. + +Args: + name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Cloud KMS Autokey configuration for a folder or project. + "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. + "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. + "state": "A String", # Output only. The state for the AutokeyConfig. +}++getKajPolicyConfig(name, x__xgafv=None)Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects. @@ -202,6 +230,39 @@Method Details
}++updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)+Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey. + +Args: + name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. (required) + body: object, The request body. + The object takes the form of: + +{ # Cloud KMS Autokey configuration for a folder or project. + "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. + "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. + "state": "A String", # Output only. The state for the AutokeyConfig. +} + + updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Cloud KMS Autokey configuration for a folder or project. + "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. + "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. + "state": "A String", # Output only. The state for the AutokeyConfig. +}++updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects. diff --git a/docs/dyn/cloudkms_v1.projects.locations.html b/docs/dyn/cloudkms_v1.projects.locations.html index 700f3d7c18..e3a2da1098 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.html +++ b/docs/dyn/cloudkms_v1.projects.locations.html @@ -207,7 +207,7 @@Method Details
Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) 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: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html index 184bd3616d..d24f85ba12 100644 --- a/docs/dyn/compute_alpha.networks.html +++ b/docs/dyn/compute_alpha.networks.html @@ -77,6 +77,9 @@Instance Methods
addPeering(project, network, body=None, requestId=None, x__xgafv=None)Adds a peering to the specified network.
++
+cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.
Close httplib2 connections.
@@ -301,6 +304,138 @@Method Details
}++cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)+Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network. + +Args: + project: string, Project ID for this request. (required) + network: string, Name of the network resource to remove peering from. (required) + body: object, The request body. + The object takes the form of: + +{ + "name": "A String", # Name of the peering, which should conform to RFC1035. +} + + requestId: string, An optional request 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. 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 if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. +}+close()Close httplib2 connections.diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html index cf743ab9f9..721c6239e0 100644 --- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html +++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html @@ -117,10 +117,10 @@Instance Methods
move(securityPolicy, parentId=None, requestId=None, x__xgafv=None)Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.
-
+patch(securityPolicy, body=None, requestId=None, x__xgafv=None)patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
-
+patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
@@ -2244,7 +2244,7 @@
removeAssociation(securityPolicy, name=None, requestId=None, x__xgafv=None)Method Details
-patch(securityPolicy, body=None, requestId=None, x__xgafv=None)+patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. Args: @@ -2523,6 +2523,7 @@Method Details
} requestId: string, An optional request 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. 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 if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + updateMask: string, Indicates fields to be cleared as part of this request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -2641,7 +2642,7 @@Method Details
-patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)+patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. Args: @@ -2820,6 +2821,7 @@Method Details
priority: integer, The priority of the rule to patch. requestId: string, An optional request 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. 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 if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + updateMask: string, Indicates fields to be cleared as part of this request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html index 35355b3427..dd55a45b39 100644 --- a/docs/dyn/compute_alpha.projects.html +++ b/docs/dyn/compute_alpha.projects.html @@ -109,7 +109,7 @@Instance Methods
Retrieves the next page of results.
-
moveDisk(project, body=None, requestId=None, x__xgafv=None)Moves a persistent disk from one zone to another.
+Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
moveInstance(project, body=None, requestId=None, x__xgafv=None)Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.
@@ -910,7 +910,7 @@Method Details
moveDisk(project, body=None, requestId=None, x__xgafv=None)-Moves a persistent disk from one zone to another. +Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption. Args: project: string, Project ID for this request. (required) diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index 504e4c1cda..80671f101c 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -248,6 +248,7 @@@@ -198,6 +201,9 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -867,6 +868,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -1463,6 +1465,7 @@Method Details
"ipAddress": "A String", # IP address of the local BGP interface. "ipv4NexthopAddress": "A String", # IPv4 address of the local BGP interface. "ipv6NexthopAddress": "A String", # IPv6 address of the local BGP interface. + "linkedCustomHardware": "A String", # The URI of the linked custom hardware resource, CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource is the one that will establish the BGP session from the Cloud Router. "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls. "md5AuthEnabled": True or False, # Informs whether MD5 authentication is enabled on this BGP peer. "name": "A String", # Name of this BGP peer. Unique within the Routers resource. @@ -1586,6 +1589,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -1900,6 +1904,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -2364,6 +2369,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -2964,6 +2970,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -3146,6 +3153,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -3364,6 +3372,7 @@Method Details
"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface. "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. diff --git a/docs/dyn/compute_beta.interconnectLocations.html b/docs/dyn/compute_beta.interconnectLocations.html index 31b9d463a0..24fe7b806a 100644 --- a/docs/dyn/compute_beta.interconnectLocations.html +++ b/docs/dyn/compute_beta.interconnectLocations.html @@ -139,6 +139,9 @@Method Details
}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + "A String", + ], "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. "supportsPzs": True or False, # [Output Only] Reserved for future use. }Method Details
}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + "A String", + ], "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. "supportsPzs": True or False, # [Output Only] Reserved for future use. }, diff --git a/docs/dyn/compute_beta.organizationSecurityPolicies.html b/docs/dyn/compute_beta.organizationSecurityPolicies.html index 0645da84ea..d465b0342e 100644 --- a/docs/dyn/compute_beta.organizationSecurityPolicies.html +++ b/docs/dyn/compute_beta.organizationSecurityPolicies.html @@ -117,10 +117,10 @@Instance Methods
move(securityPolicy, parentId=None, requestId=None, x__xgafv=None)Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.
-
+patch(securityPolicy, body=None, requestId=None, x__xgafv=None)patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
-
+patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
@@ -2149,7 +2149,7 @@
removeAssociation(securityPolicy, name=None, requestId=None, x__xgafv=None)Method Details
-patch(securityPolicy, body=None, requestId=None, x__xgafv=None)+patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead. Args: @@ -2409,6 +2409,7 @@Method Details
} requestId: string, An optional request 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. 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 if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + updateMask: string, Indicates fields to be cleared as part of this request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -2526,7 +2527,7 @@Method Details
-patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)+patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead. Args: @@ -2691,6 +2692,7 @@Method Details
priority: integer, The priority of the rule to patch. requestId: string, An optional request 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. 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 if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + updateMask: string, Indicates fields to be cleared as part of this request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html index bdb5dc5164..8035e452f2 100644 --- a/docs/dyn/compute_beta.projects.html +++ b/docs/dyn/compute_beta.projects.html @@ -109,7 +109,7 @@Instance Methods
Retrieves the next page of results.
-
moveDisk(project, body=None, requestId=None, x__xgafv=None)Moves a persistent disk from one zone to another.
+Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
moveInstance(project, body=None, requestId=None, x__xgafv=None)Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.
@@ -902,7 +902,7 @@Method Details
moveDisk(project, body=None, requestId=None, x__xgafv=None)-Moves a persistent disk from one zone to another. +Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption. Args: project: string, Project ID for this request. (required) diff --git a/docs/dyn/compute_v1.interconnectLocations.html b/docs/dyn/compute_v1.interconnectLocations.html index f9e2fc2309..c5744d26ed 100644 --- a/docs/dyn/compute_v1.interconnectLocations.html +++ b/docs/dyn/compute_v1.interconnectLocations.html @@ -134,6 +134,9 @@@@ -188,6 +191,9 @@Method Details
}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + "A String", + ], "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. "supportsPzs": True or False, # [Output Only] Reserved for future use. }Method Details
}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + "A String", + ], "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. "supportsPzs": True or False, # [Output Only] Reserved for future use. }, diff --git a/docs/dyn/compute_v1.interconnectRemoteLocations.html b/docs/dyn/compute_v1.interconnectRemoteLocations.html index aef60b281d..50cb7abd9b 100644 --- a/docs/dyn/compute_v1.interconnectRemoteLocations.html +++ b/docs/dyn/compute_v1.interconnectRemoteLocations.html @@ -137,6 +137,7 @@Method Details
"lacp": "A String", # [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED "maxLagSize100Gbps": 42, # [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps. "maxLagSize10Gbps": 42, # [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. + "maxLagSize400Gbps": 42, # [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps. "name": "A String", # [Output Only] Name of the resource. "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). "permittedConnections": [ # [Output Only] Permitted connections. @@ -202,6 +203,7 @@Method Details
"lacp": "A String", # [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED "maxLagSize100Gbps": 42, # [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps. "maxLagSize10Gbps": 42, # [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. + "maxLagSize400Gbps": 42, # [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps. "name": "A String", # [Output Only] Name of the resource. "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). "permittedConnections": [ # [Output Only] Permitted connections. diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html index 714bb4c6c8..68e07b1d1b 100644 --- a/docs/dyn/compute_v1.projects.html +++ b/docs/dyn/compute_v1.projects.html @@ -109,7 +109,7 @@Instance Methods
Retrieves the next page of results.
-
moveDisk(project, body=None, requestId=None, x__xgafv=None)Moves a persistent disk from one zone to another.
+Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
moveInstance(project, body=None, requestId=None, x__xgafv=None)Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.
@@ -896,7 +896,7 @@Method Details
moveDisk(project, body=None, requestId=None, x__xgafv=None)-Moves a persistent disk from one zone to another. +Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption. Args: project: string, Project ID for this request. (required) diff --git a/docs/dyn/compute_v1.regionUrlMaps.html b/docs/dyn/compute_v1.regionUrlMaps.html index 06b68a8bc8..c8f8713c2b 100644 --- a/docs/dyn/compute_v1.regionUrlMaps.html +++ b/docs/dyn/compute_v1.regionUrlMaps.html @@ -302,6 +302,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -450,6 +451,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -589,6 +591,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -770,6 +773,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -917,6 +921,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1065,6 +1070,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1204,6 +1210,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1385,6 +1392,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1661,6 +1669,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1809,6 +1818,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1948,6 +1958,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2129,6 +2140,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2306,6 +2318,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2454,6 +2467,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2593,6 +2607,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2774,6 +2789,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3038,6 +3054,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3186,6 +3203,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3325,6 +3343,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3506,6 +3525,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3771,6 +3791,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3919,6 +3940,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4058,6 +4080,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4239,6 +4262,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html index 1be4e1a746..d0f9d745da 100644 --- a/docs/dyn/compute_v1.subnetworks.html +++ b/docs/dyn/compute_v1.subnetworks.html @@ -90,7 +90,7 @@Instance Methods
expandIpCidrRange(project, region, subnetwork, body=None, requestId=None, x__xgafv=None)Expands the IP CIDR range of the subnetwork to a specified value.
-
+get(project, region, subnetwork, x__xgafv=None)get(project, region, subnetwork, views=None, x__xgafv=None)Returns the specified subnetwork.
@@ -99,7 +99,7 @@
getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)Instance Methods
insert(project, region, body=None, requestId=None, x__xgafv=None)Creates a subnetwork in the specified project using the data included in the request.
+list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, views=None, x__xgafv=None)Retrieves a list of subnetworks available to the specified project.
@@ -203,6 +203,45 @@Method Details
"systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. "A String", ], + "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + { # The IPV4 utilization of a single IP range. + "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range. + "totalAllocatedIp": "A String", + "totalFreeIp": "A String", + }, + ], + }, }, ], "warning": { # An informational warning that appears when the list of addresses is empty. @@ -513,13 +552,17 @@Method Details
-@@ -699,6 +781,45 @@get(project, region, subnetwork, x__xgafv=None)+get(project, region, subnetwork, views=None, x__xgafv=None)Returns the specified subnetwork. Args: project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) subnetwork: string, Name of the Subnetwork resource to return. (required) + views: string, Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. (repeated) + Allowed values + DEFAULT - + WITH_UTILIZATION - Utilization data is included in the response. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -582,6 +625,45 @@Method Details
"systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. "A String", ], + "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + { # The IPV4 utilization of a single IP range. + "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range. + "totalAllocatedIp": "A String", + "totalFreeIp": "A String", + }, + ], + }, }Method Details
"systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. "A String", ], + "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + { # The IPV4 utilization of a single IP range. + "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range. + "totalAllocatedIp": "A String", + "totalFreeIp": "A String", + }, + ], + }, } requestId: string, An optional request 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. 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 if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -819,7 +940,7 @@Method Details
-list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, views=None, x__xgafv=None)Retrieves a list of subnetworks available to the specified project. Args: @@ -830,6 +951,10 @@Method Details
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + views: string, Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. (repeated) + Allowed values + DEFAULT - + WITH_UTILIZATION - Utilization data is included in the response. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -895,6 +1020,45 @@Method Details
"systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. "A String", ], + "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + { # The IPV4 utilization of a single IP range. + "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range. + "totalAllocatedIp": "A String", + "totalFreeIp": "A String", + }, + ], + }, }, ], "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. @@ -1081,6 +1245,45 @@Method Details
"systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use. "A String", ], + "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. + "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range. + "totalAllocatedIp": { + "high": "A String", + "low": "A String", + }, + "totalFreeIp": { + "high": "A String", + "low": "A String", + }, + }, + "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty. + { # The IPV4 utilization of a single IP range. + "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range. + "totalAllocatedIp": "A String", + "totalFreeIp": "A String", + }, + ], + }, } drainTimeoutSeconds: integer, The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html index 82d5204005..44a11874df 100644 --- a/docs/dyn/compute_v1.urlMaps.html +++ b/docs/dyn/compute_v1.urlMaps.html @@ -191,6 +191,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -339,6 +340,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -478,6 +480,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -659,6 +662,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -984,6 +988,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1132,6 +1137,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1271,6 +1277,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1452,6 +1459,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1598,6 +1606,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1746,6 +1755,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -1885,6 +1895,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2066,6 +2077,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2476,6 +2488,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2624,6 +2637,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2763,6 +2777,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -2944,6 +2959,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3120,6 +3136,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3268,6 +3285,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3407,6 +3425,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3588,6 +3607,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3851,6 +3871,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -3999,6 +4020,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4138,6 +4160,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4319,6 +4342,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4586,6 +4610,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4734,6 +4759,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -4873,6 +4899,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. @@ -5054,6 +5081,7 @@Method Details
}, "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. + "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`. }, "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1. diff --git a/docs/dyn/config_v1.projects.locations.html b/docs/dyn/config_v1.projects.locations.html index 8a3fd5ce69..cbda2afda4 100644 --- a/docs/dyn/config_v1.projects.locations.html +++ b/docs/dyn/config_v1.projects.locations.html @@ -145,7 +145,7 @@Method Details
Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) 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: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/connectors_v2.projects.locations.connections.tools.html b/docs/dyn/connectors_v2.projects.locations.connections.tools.html index c0938adf23..cd68df125b 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.tools.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.tools.html @@ -142,6 +142,13 @@Method Details
"nextPageToken": "A String", # Next page token. "tools": [ # List of available tools. { # Message representing a single tool. + "annotations": { # ToolAnnotations holds annotations for a tool. # Annotations for the tool. + "destructiveHint": True or False, # If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`) + "idempotentHint": True or False, # If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`) + "openWorldHint": True or False, # If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. + "readOnlyHint": True or False, # If true, the tool does not modify its environment. + "title": "A String", # A human-readable title for the tool. + }, "dependsOn": [ # List of tool names that this tool depends on. "A String", ], diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html index d59b6f9257..acae11f8ec 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.html @@ -74,11 +74,6 @@Dataform API . projects . locations
Instance Methods
--
-folders()-Returns the folders Resource.
- @@ -89,11 +84,6 @@Instance Methods
Returns the repositories Resource.
--
-teamFolders()-Returns the teamFolders Resource.
-Close httplib2 connections.
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index 59f6d05cf6..72fd845ac5 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -126,9 +126,6 @@Instance Methods
Fetches a single Repository.
--
-getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
@@ -147,12 +144,6 @@Instance Methods
readFile(name, commitSha=None, path=None, x__xgafv=None)Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.
--
-setIamPolicy(resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
--
-testIamPermissions(resource, body=None, x__xgafv=None)Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Method Details
-close()@@ -436,41 +427,6 @@Method Details
}--getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)-Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - -Args: - resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) - options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - "bindings": [ # 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`. - { # Associates `members`, or principals, with a `role`. - "condition": { # 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. # 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). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # 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. - }, - "members": [ # 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`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - "A String", - ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). - }, - ], - "etag": "A String", # `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": 42, # 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). -}--list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*. @@ -691,92 +647,4 @@Method Details
}-- -setIamPolicy(resource, body=None, x__xgafv=None)-Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - -Args: - resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) - body: object, The request body. - The object takes the form of: - -{ # Request message for `SetIamPolicy` method. - "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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. - "bindings": [ # 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`. - { # Associates `members`, or principals, with a `role`. - "condition": { # 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. # 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). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # 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. - }, - "members": [ # 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`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - "A String", - ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). - }, - ], - "etag": "A String", # `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": 42, # 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). - }, -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - "bindings": [ # 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`. - { # Associates `members`, or principals, with a `role`. - "condition": { # 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. # 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). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # 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. - }, - "members": [ # 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`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - "A String", - ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). - }, - ], - "etag": "A String", # `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": 42, # 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). -}---testIamPermissions(resource, body=None, x__xgafv=None)-Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - -Args: - resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) - body: object, The request body. - The object takes the form of: - -{ # Request message for `TestIamPermissions` method. - "permissions": [ # 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). - "A String", - ], -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # Response message for `TestIamPermissions` method. - "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - "A String", - ], -}-