Returns the cmekConfigs Resource.
Returns the collections Resource.
Returns the dataStores Resource.
Returns the evaluations Resource.
Returns the groundingConfigs Resource.
Returns the identityMappingStores Resource.
Returns the operations Resource.
Returns the rankingConfigs Resource.
Returns the requirements Resource.
Returns the sampleQuerySets Resource.
Returns the userEvents Resource.
Returns the userStores Resource.
Close httplib2 connections.
estimateDataSize(location, body=None, x__xgafv=None)
Estimates the data size to be used by a customer.
generateGroundedContent(location, body=None, x__xgafv=None)
Generates grounded content.
getAclConfig(name, x__xgafv=None)
Gets the AclConfig.
getCmekConfig(name, x__xgafv=None)
Gets the CmekConfig.
setUpDataConnector(parent, body=None, x__xgafv=None)
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
updateAclConfig(name, body=None, x__xgafv=None)
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
updateCmekConfig(name, body=None, setDefault=None, x__xgafv=None)
Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
close()
Close httplib2 connections.
estimateDataSize(location, body=None, x__xgafv=None)
Estimates the data size to be used by a customer. Args: location: string, Required. Full resource name of the location, such as `projects/{project}/locations/{location}`. (required) body: object, The request body. The object takes the form of: { # Request message for EstimateBillingService.EstimateDataSize method "fileDataSource": { # Data source contains files either in Cloud Storage or BigQuery. # Structured or unstructured data. "bigquerySource": { # BigQuery source import data from. # BigQuery input source. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). "A String", ], }, }, "websiteDataSource": { # Data source is a set of website patterns that we crawl to get the total number of websites. # Website data. "estimatorUriPatterns": [ # Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown. { # URI patterns that we use to crawl. "exactMatch": True or False, # Whether we infer the generated URI or use the exact provided one. "exclusive": True or False, # Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default. "providedUriPattern": "A String", # User provided URI pattern. For example, `foo.com/bar/*`. }, ], }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # 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). # The error result of the operation in case of failure or cancellation. "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. }, "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
generateGroundedContent(location, body=None, x__xgafv=None)
Generates grounded content. Args: location: string, Required. Location resource. Format: `projects/{project}/locations/{location}`. (required) body: object, The request body. The object takes the form of: { # Top-level message sent by the client for the `GenerateGroundedContent` method. "contents": [ # Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. { # Base structured datatype containing multi-part content of a message. "parts": [ # Ordered `Parts` that constitute a single message. { # Single part of content. "text": "A String", # Inline text. }, ], "role": "A String", # Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. }, ], "generationSpec": { # Content generation specification. # Content generation specification. "frequencyPenalty": 3.14, # If specified, custom value for frequency penalty will be used. "languageCode": "A String", # Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). "maxOutputTokens": 42, # If specified, custom value for max output tokens will be used. "modelId": "A String", # Specifies which Vertex model id to use for generation. "presencePenalty": 3.14, # If specified, custom value for presence penalty will be used. "seed": 42, # If specified, custom value for the seed will be used. "temperature": 3.14, # If specified, custom value for the temperature will be used. "topK": 42, # If specified, custom value for top-k sampling will be used. "topP": 3.14, # If specified, custom value for nucleus sampling will be used. }, "groundingSpec": { # Grounding specification. # Grounding specification. "groundingSources": [ # Grounding sources. { # Grounding source. "googleSearchSource": { # Google Search config parameters. # If set, grounding is performed with Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Optional. Specifies the dynamic retrieval configuration for the given source. "predictor": { # Describes the predictor settings for dynamic retrieval. # Specification for the predictor for dynamic retrieval. "threshold": 3.14, # The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source. "version": "A String", # The version of the predictor to be used in dynamic retrieval. }, }, }, "inlineSource": { # Message to be used for grounding based on inline content. # If set, grounding is performed with inline content. "attributes": { # Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content). "a_key": "A String", }, "groundingFacts": [ # List of facts to be used for grounding. { # Grounding Fact. "attributes": { # Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. "a_key": "A String", }, "factText": "A String", # Text content of the fact. Can be at most 10K characters long. }, ], }, "searchSource": { # Message to be used for grounding with Vertex AI Search. # If set, grounding is performed with Vertex AI Search. "filter": "A String", # Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. "maxResultCount": 42, # Number of search results to return. The default value is 10. The maximumm allowed value is 10. "safeSearch": True or False, # If set, safe search is enabled in Vertex AI Search requests. "servingConfig": "A String", # The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` }, }, ], }, "systemInstruction": { # Base structured datatype containing multi-part content of a message. # Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them. "parts": [ # Ordered `Parts` that constitute a single message. { # Single part of content. "text": "A String", # Inline text. }, ], "role": "A String", # Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. }, "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "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 for the `GenerateGroundedContent` method. "candidates": [ # Generated candidates. { # A response candidate generated from the model. "content": { # Base structured datatype containing multi-part content of a message. # Content of the candidate. "parts": [ # Ordered `Parts` that constitute a single message. { # Single part of content. "text": "A String", # Inline text. }, ], "role": "A String", # Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset. }, "groundingMetadata": { # Citation for the generated content. # Grounding metadata for the generated content. "groundingSupport": [ # GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact. { # Grounding info for a claim in the candidate and its support. "claimText": "A String", # Text for the claim in the candidate. Always provided when a support is found. "supportChunkIndices": [ # A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim. 42, ], "supportScore": 3.14, # A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks. }, ], "retrievalMetadata": [ # Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users. { # Describes the metadata associated with a retrieval step. "dynamicRetrievalMetadata": { # Describes the metadata about dynamic retrieval. # Metadata for dynamic retrieval. "predictorMetadata": { # Describes the metadata about the dynamic retrieval predictor. # Metadata for the dynamic retrieval predictor. "prediction": 3.14, # The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. "version": "A String", # The version of the predictor which was used in dynamic retrieval. }, }, "source": "A String", # Describes the source to which the metadata is referring to. }, ], "searchEntryPoint": { # Google search entry point. # Google search entry for the following-up web searches. "renderedContent": "A String", # Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Base64 encoded JSON representing array of tuple. }, "supportChunks": [ # List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request. { # Fact Chunk. "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long. "index": 42, # The index of this chunk. Currently, only used for the streaming mode. "source": "A String", # Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. "sourceMetadata": { # More fine-grained information for the source reference. "a_key": "A String", }, }, ], "webSearchQueries": [ # Web search queries for the following-up web search. "A String", ], }, "groundingScore": 3.14, # The overall grounding score for the candidate, in the range of [0, 1]. "index": 42, # Index of the candidate. }, ], }
getAclConfig(name, x__xgafv=None)
Gets the AclConfig. Args: name: string, Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Access Control Configuration. "idpConfig": { # Identity Provider Config. # Identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" }, "idpType": "A String", # Identity provider type configured. }, "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. }
getCmekConfig(name, x__xgafv=None)
Gets the CmekConfig. Args: name: string, Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Configurations used to enable CMEK data encryption with Cloud KMS keys. "isDefault": True or False, # Output only. The default CmekConfig for the Customer. "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. "singleRegionKeys": [ # Optional. Single-regional CMEKs that are required for some VAIS features. { # Metadata for single-regional CMEKs. "kmsKey": "A String", # Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. }, ], "state": "A String", # Output only. State of the CmekConfig. }
setUpDataConnector(parent, body=None, x__xgafv=None)
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. Args: parent: string, Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`. (required) body: object, The request body. The object takes the form of: { # Request for DataConnectorService.SetUpDataConnector method. "collectionDisplayName": "A String", # Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters. "collectionId": "A String", # Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. "dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. // # Required. The DataConnector to initialize in the newly created Collection. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. }, "autoRunDisabled": True or False, # Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], "createTime": "A String", # Output only. Timestamp the DataConnector was created at. "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services. { # Defines target endpoints used to connect to third-party sources. "destinations": [ # Optional. The destinations for the corresponding key. { # Defines a target endpoint "host": "A String", # Publicly routable host. "port": 42, # Optional. Target port number accepted by the destination. }, ], "key": "A String", # Optional. Unique destination identifier that is supported by the connector. "params": { # Optional. Additional parameters for this destination config. "a_key": "", # Properties of the object. }, }, ], "entities": [ # List of entities from the connected data source to ingest. { # Represents an entity in the data source. For example, the `Account` object in Salesforce. "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity. "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space` "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. "a_key": "A String", }, "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id. "a_key": "", # Properties of the object. }, }, ], "errors": [ # Output only. The errors from initialization or from the latest connector run. { # 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). "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. }, ], "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. }, "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed. "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered. "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone. "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". }, "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. "a_key": "", # Properties of the object. }, "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function. "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. "state": "A String", # Output only. State of the connector. "staticIpAddresses": [ # Output only. The static IP addresses used by this connector. "A String", ], "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector. "syncMode": "A String", # The data synchronization mode supported by the data connector. "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated. }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # 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). # The error result of the operation in case of failure or cancellation. "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. }, "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
updateAclConfig(name, body=None, x__xgafv=None)
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. Args: name: string, Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required) body: object, The request body. The object takes the form of: { # Access Control Configuration. "idpConfig": { # Identity Provider Config. # Identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" }, "idpType": "A String", # Identity provider type configured. }, "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Access Control Configuration. "idpConfig": { # Identity Provider Config. # Identity provider config. "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" }, "idpType": "A String", # Identity provider type configured. }, "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. }
updateCmekConfig(name, body=None, setDefault=None, x__xgafv=None)
Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. Args: name: string, Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. (required) body: object, The request body. The object takes the form of: { # Configurations used to enable CMEK data encryption with Cloud KMS keys. "isDefault": True or False, # Output only. The default CmekConfig for the Customer. "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation. "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. "singleRegionKeys": [ # Optional. Single-regional CMEKs that are required for some VAIS features. { # Metadata for single-regional CMEKs. "kmsKey": "A String", # Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. }, ], "state": "A String", # Output only. State of the CmekConfig. } setDefault: boolean, Set the following CmekConfig as the default to be used for child resources if one is not specified. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. "error": { # 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). # The error result of the operation in case of failure or cancellation. "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. }, "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }