Close httplib2 connections.
+ +Gets a Platform Child Site for a specified Platform Child Account and site.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Child Sites for a specified Platform Child Account.
@@ -92,6 +95,27 @@Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets a Platform Child Site for a specified Platform Child Account and site.
+
+Args:
+ name: string, Required. The name of the platform child site to retrieve. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of a Transparent Platform Child Site.
+ "domain": "A String", # Output only. Domain URL of the Platform Child Site. Part of the PlatformChildSite name.
+ "name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/childAccounts/{child_account}/sites/{platform_child_site}
+ "platformGroup": "A String", # Resource name of the Platform Group of the Platform Child Site.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Child Sites for a specified Platform Child Account. diff --git a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html index 4c44d9a05e5..fc4614ffd4e 100644 --- a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html +++ b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html @@ -77,6 +77,9 @@Instance Methods
Close httplib2 connections.
+ +Gets a Platform Group for a specified Platform and group.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists Platform Groups for a specified Platform.
@@ -89,6 +92,29 @@Method Details
Close httplib2 connections.
get(name, x__xgafv=None)
+ Gets a Platform Group for a specified Platform and group.
+
+Args:
+ name: string, Required. The name of the platform group to retrieve. Format: accounts/{account}/platforms/{platform}/groups/{group} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of a Transparent Platform Group.
+ "description": "A String", # Output only. Description of the PlatformGroup.
+ "name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}
+ "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
+ "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
+ },
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Platform Groups for a specified Platform. diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 560f30b1d7c..2d667d698ad 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -154,7 +154,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -238,7 +239,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -368,7 +370,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -381,6 +384,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -560,6 +566,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -672,7 +680,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -808,7 +817,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -836,6 +846,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1015,6 +1028,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1081,7 +1096,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1354,7 +1370,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1490,7 +1507,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1518,6 +1536,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1697,6 +1718,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1763,7 +1786,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 64ee3c19281..cb75c01fbcd 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -146,7 +146,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -198,7 +199,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -226,6 +228,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -405,6 +410,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -462,7 +469,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -514,7 +522,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -542,6 +551,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -721,6 +733,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -803,7 +817,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -855,7 +870,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -883,6 +899,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1062,6 +1081,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1130,7 +1151,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1182,7 +1204,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1210,6 +1233,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1389,6 +1415,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1465,7 +1493,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1517,7 +1546,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1545,6 +1575,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1724,6 +1757,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1782,7 +1817,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1834,7 +1870,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1862,6 +1899,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -2041,6 +2081,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 405b58a5057..7551d4a250a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -207,7 +207,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -291,7 +292,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -421,7 +423,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -434,6 +437,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -613,6 +619,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1604,7 +1612,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1740,7 +1749,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1768,6 +1778,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1947,6 +1960,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2013,7 +2028,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -3705,7 +3721,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -3841,7 +3858,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -3869,6 +3887,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -4048,6 +4069,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -4114,7 +4137,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index bf83bcf2f83..7817b4badb7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -317,7 +317,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -405,7 +406,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -484,7 +486,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -766,7 +769,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -857,7 +861,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index d0773660fc6..e98f5576c8b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -158,7 +158,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -242,7 +243,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -372,7 +374,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -385,6 +388,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -564,6 +570,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -676,7 +684,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -812,7 +821,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -840,6 +850,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1019,6 +1032,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1085,7 +1100,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1586,7 +1602,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1722,7 +1739,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1750,6 +1768,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1929,6 +1950,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1995,7 +2018,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 42c5a5e2aa0..b0d7d02af94 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -236,7 +236,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -407,7 +408,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -585,7 +587,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -769,7 +772,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -968,7 +972,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index bade9af8864..096c68c98a8 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -152,7 +152,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -236,7 +237,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -366,7 +368,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -379,6 +382,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -558,6 +564,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -670,7 +678,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -806,7 +815,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -834,6 +844,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1013,6 +1026,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1079,7 +1094,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1903,7 +1919,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2039,7 +2056,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2067,6 +2085,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -2246,6 +2267,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2312,7 +2335,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 737c0bf6409..3b773ba44ba 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -156,7 +156,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -242,7 +243,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -377,7 +379,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -390,6 +393,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -576,6 +582,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -690,7 +698,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -831,7 +840,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -859,6 +869,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1045,6 +1058,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1113,7 +1128,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1391,7 +1407,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1532,7 +1549,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1560,6 +1578,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1746,6 +1767,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1814,7 +1837,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index b07f1415efd..5b1e7d57e93 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -148,7 +148,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -202,7 +203,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -230,6 +232,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -416,6 +421,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -475,7 +482,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -529,7 +537,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -557,6 +566,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -743,6 +755,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -827,7 +841,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -881,7 +896,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -909,6 +925,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1095,6 +1114,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1165,7 +1186,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1219,7 +1241,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1247,6 +1270,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1433,6 +1459,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1511,7 +1539,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1565,7 +1594,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1593,6 +1623,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1779,6 +1812,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. @@ -1839,7 +1874,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1893,7 +1929,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1921,6 +1958,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -2107,6 +2147,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], "ttl": "A String", # Input only. The TTL for this resource. The expiration time is computed: now + TTL. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index bfd18f8d94e..9cd0d4133f2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -194,7 +194,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -336,7 +337,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -364,6 +366,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -550,6 +555,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, @@ -598,7 +605,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -740,7 +748,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -768,6 +777,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -954,6 +966,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, @@ -1051,7 +1065,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1193,7 +1208,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1221,6 +1237,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1407,6 +1426,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, @@ -1455,7 +1476,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1597,7 +1619,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1625,6 +1648,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1811,6 +1837,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 0b1659e66ed..9cb776496e0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -218,7 +218,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -304,7 +305,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -439,7 +441,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -452,6 +455,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -638,6 +644,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1790,7 +1798,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1931,7 +1940,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1959,6 +1969,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -2145,6 +2158,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2213,7 +2228,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -4084,7 +4100,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -4225,7 +4242,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -4253,6 +4271,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -4439,6 +4460,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -4507,7 +4530,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 8ac8a7c8a45..94669cb1f92 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -278,7 +278,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -326,7 +327,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -578,7 +580,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -658,7 +661,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -706,7 +710,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -785,7 +790,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -833,7 +839,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -910,7 +917,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -958,7 +966,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 5d7a88e8288..33eb6cd5b0d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1181,7 +1181,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1240,7 +1241,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 711718edbdf..60e1ea212ad 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -376,7 +376,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -473,7 +474,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -554,7 +556,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1120,7 +1123,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1213,7 +1217,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 9990bac54f5..a26b612a3df 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -172,7 +172,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -258,7 +259,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -393,7 +395,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -406,6 +409,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -592,6 +598,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -778,7 +786,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -919,7 +928,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -947,6 +957,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1133,6 +1146,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1201,7 +1216,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1794,7 +1810,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1935,7 +1952,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1963,6 +1981,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -2149,6 +2170,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2217,7 +2240,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.html new file mode 100644 index 00000000000..672ad728afa --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.html @@ -0,0 +1,91 @@ + + + +Vertex AI API . projects . locations . reasoningEngines . examples
+Instance Methods
++
+operations()+Returns the operations Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.operations.html new file mode 100644 index 00000000000..56f03f94c99 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.examples.operations.html @@ -0,0 +1,205 @@ + + + +close()+Close httplib2 connections.+Vertex AI API . projects . locations . reasoningEngines . examples . operations
+Instance Methods
+ +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
++
+close()Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
++
+wait(name, timeout=None, x__xgafv=None)Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+Method Details
+++ +cancel(name, x__xgafv=None)+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + +Args: + name: string, The name of the operation resource to be cancelled. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +close()+Close httplib2 connections.+++ +delete(name, x__xgafv=None)+Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + +Args: + name: string, The name of the operation resource to be deleted. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(name, x__xgafv=None)+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + +Args: + name: string, The name of the operation resource. (required) + 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. + }, +}+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 5c6d15ea05a..176e9632acf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -74,6 +74,11 @@wait(name, timeout=None, x__xgafv=None)+Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + +Args: + name: string, The name of the operation resource to wait on. (required) + timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + 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. + }, +}+Vertex AI API . projects . locations . reasoningEngines
Instance Methods
++
+examples()+Returns the examples Resource.
+ diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index 2643226f290..e689c147d1e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -161,7 +161,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 4f460e6ffd6..388d4d7abf5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -171,7 +171,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 56640f9f474..36962f36033 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -182,6 +182,8 @@Method Details
"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -252,7 +254,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -362,7 +365,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -479,6 +483,8 @@Method Details
"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -549,7 +555,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -659,7 +666,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -783,6 +791,8 @@Method Details
"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -853,7 +863,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -963,7 +974,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1093,6 +1105,8 @@Method Details
"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -1163,7 +1177,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1273,7 +1288,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1418,6 +1434,8 @@Method Details
"validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. }, "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -1488,7 +1506,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -1598,7 +1617,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 1c8e3edf18b..7b0c3a07f33 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -160,7 +160,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -246,7 +247,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -381,7 +383,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -394,6 +397,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -580,6 +586,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -694,7 +702,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -835,7 +844,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -863,6 +873,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -1049,6 +1062,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -1117,7 +1132,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2542,7 +2558,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2683,7 +2700,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. @@ -2711,6 +2729,9 @@Method Details
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. @@ -2897,6 +2918,8 @@Method Details
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, ], } @@ -2965,7 +2988,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index fd7005c8397..712f5795671 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -161,7 +161,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index be1760a8c43..b2a7dc0f4be 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -166,7 +166,8 @@Method Details
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Output only. Indicates if the part is thought from the model. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. "startOffset": "A String", # Optional. The start offset of the video. diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 0cacd7bd764..d3e4f5970ac 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -157,7 +157,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -305,7 +305,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -544,7 +544,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -739,7 +739,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -876,7 +876,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index f1e574d7230..4133fd4d008 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -294,7 +294,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -505,7 +505,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -824,7 +824,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1070,7 +1070,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1270,7 +1270,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1531,7 +1531,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1753,7 +1753,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 7210e3c1068..a316d2dccd4 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -184,7 +184,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -365,7 +365,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -637,7 +637,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -869,7 +869,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -1039,7 +1039,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index cfc93d0e733..2aab3527267 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -293,7 +293,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -503,7 +503,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -821,7 +821,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1066,7 +1066,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1265,7 +1265,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1525,7 +1525,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. @@ -1746,7 +1746,7 @@Method Details
"secondaryConfig": { # Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. # Cross Region replication config specific to SECONDARY cluster. "primaryClusterName": "A String", # The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} }, - "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service agent email. This service account is created per-cluster per-project, and is different from that of the primary service agent which is created per-project. The service account naming format is subject to change. + "serviceAccountEmail": "A String", # Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change. "sslConfig": { # SSL configuration. # SSL configuration for this AlloyDB cluster. "caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. "sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index 94d3754f048..40c5a8da289 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -184,7 +184,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -364,7 +364,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -635,7 +635,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -866,7 +866,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. @@ -1035,7 +1035,7 @@Method Details
}, "name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} "networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration. - "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. "authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance. { # AuthorizedNetwork contains metadata for an authorized network. "cidrRange": "A String", # CIDR range for one authorzied network of the instance. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index 293f9445153..5d6c0bb9488 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -1059,6 +1059,11 @@Method Details
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. }, }, + "subpropertySyncConfig": { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. # A snapshot of a SubpropertySyncConfig resource in change history. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 + }, }, "resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing. "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history. @@ -1579,6 +1584,11 @@Method Details
"postbackWindowSettingsEnabled": True or False, # If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. }, }, + "subpropertySyncConfig": { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. # A snapshot of a SubpropertySyncConfig resource in change history. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 + }, }, }, ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index cb534b5c5ac..2a588d509b9 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -174,6 +174,11 @@Instance Methods
Returns the subpropertyEventFilters Resource.
+ +Returns the subpropertySyncConfigs Resource.
+
acknowledgeUserDataCollection(property, body=None, x__xgafv=None)Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
@@ -753,6 +758,7 @@Method Details
The object takes the form of: { # Request message for CreateSubproperty RPC. + "customDimensionAndMetricSynchronizationMode": "A String", # Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics "subproperty": { # A resource message representing a Google Analytics property. # Required. The subproperty to create. "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123" "createTime": "A String", # Output only. Time when the entity was originally created. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html b/docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html new file mode 100644 index 00000000000..d16c49c1c2e --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html @@ -0,0 +1,192 @@ + + + +Google Analytics Admin API . properties . subpropertySyncConfigs
+Instance Methods
++
+close()Close httplib2 connections.
+ +Lookup for a single Subproperty Sync Config.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)List all Subproperty Sync Configs on a property.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates a Subproperty Sync Config.
+Method Details
+++ +close()+Close httplib2 connections.+++ +get(name, x__xgafv=None)+Lookup for a single Subproperty Sync Config. + +Args: + name: string, Required. Resource name of the SubpropertySyncConfig to lookup. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+List all Subproperty Sync Configs on a property. + +Args: + parent: string, Required. Resource name of the property. Format: properties/property_id Example: properties/123 (required) + pageSize: integer, Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, Optional. A page token, received from a previous `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertySyncConfig` must match the call that provided the page token. + 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 ListSubpropertySyncConfigs RPC. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "subpropertySyncConfigs": [ # List of Subproperty Sync Configs. + { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 + }, + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index b69e1ae8372..7b8a93fa2e6 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -91,7 +91,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)+Updates a Subproperty Sync Config. + +Args: + name: string, Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 (required) + body: object, The request body. + The object takes the form of: + +{ # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 +} + + updateMask: string, Optional. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. + "applyToProperty": "A String", # Output only. Immutable. Resource name of the Subproperty that these settings apply to. + "customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. + "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 +}+Instance Methods
Enrolls an enterprise with the calling EMM.
-
generateEnterpriseUpgradeUrl(enterpriseId, adminEmail=None, allowedDomains=None, x__xgafv=None)Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available.
+Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an enterprise for more details.
generateSignupUrl(adminEmail=None, allowedDomains=None, callbackUrl=None, x__xgafv=None)Generates a sign-up URL.
@@ -276,7 +276,7 @@Method Details
diff --git a/docs/dyn/androidmanagement_v1.enterprises.html b/docs/dyn/androidmanagement_v1.enterprises.html index 6ef06d913d5..8179f9a8d4c 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.html +++ b/docs/dyn/androidmanagement_v1.enterprises.html @@ -120,7 +120,7 @@generateEnterpriseUpgradeUrl(enterpriseId, adminEmail=None, allowedDomains=None, x__xgafv=None)-Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available. +Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide to upgrading an enterprise for more details. Args: enterpriseId: string, Required. The ID of the enterprise. (required) @@ -290,7 +290,7 @@Method Details
Returns: An object of the form: - { # Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. **Note:** This feature is not generally available. + { # Response message for generating a URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. "url": "A String", # A URL for an enterprise admin to upgrade their enterprise. The page can't be rendered in an iframe. }Instance Methods
Permanently deletes an enterprise and all accounts and data associated with it. Warning: this will result in a cascaded deletion of all AM API devices associated with the deleted enterprise. Only available for EMM-managed enterprises.
-
generateEnterpriseUpgradeUrl(name, body=None, x__xgafv=None)Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available.
+Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide (https://developers.google.com/android/management/upgrade-an-enterprise) for more details.
Gets an enterprise.
@@ -292,7 +292,7 @@Method Details
generateEnterpriseUpgradeUrl(name, body=None, x__xgafv=None)-Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain.Note: This feature is not generally available. +Generates an enterprise upgrade URL to upgrade an existing managed Google Play Accounts enterprise to a managed Google domain. See the guide (https://developers.google.com/android/management/upgrade-an-enterprise) for more details. Args: name: string, Required. The name of the enterprise to be upgraded in the form enterprises/{enterpriseId}. (required) diff --git a/docs/dyn/apigee_v1.organizations.apps.html b/docs/dyn/apigee_v1.organizations.apps.html index 6b127f71c4c..ab56f40c17f 100644 --- a/docs/dyn/apigee_v1.organizations.apps.html +++ b/docs/dyn/apigee_v1.organizations.apps.html @@ -175,7 +175,7 @@Method Details
keyStatus: string, Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`. pageSize: integer, Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. "page_size" is supported from ver 1.10.0 and above. pageToken: string, Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above. - rows: string, Optional. Maximum number of app IDs to return. Defaults to 10000. + rows: string, Optional. Maximum number of app IDs to return. Defaults to 1000. startKey: string, Returns the list of apps starting from the specified app ID. status: string, Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`. x__xgafv: string, V1 error format. diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index e6bd553616d..0ff4e7cb0ca 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -319,6 +319,7 @@Method Details
"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. @@ -468,6 +469,7 @@Method Details
"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. @@ -848,6 +850,7 @@Method Details
"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. @@ -922,6 +925,7 @@Method Details
"expiresAt": "A String", # Output only. Time that the Apigee organization is scheduled for deletion. "lastModifiedAt": "A String", # Output only. Time that the Apigee organization was last modified in milliseconds since epoch. "name": "A String", # Output only. Name of the Apigee organization. + "networkEgressRestricted": True or False, # Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. "portalDisabled": True or False, # Optional. Configuration for the Portals settings. "projectId": "A String", # Output only. Project ID associated with the Apigee organization. "properties": { # Message for compatibility with legacy Edge specification for Java Properties object in JSON. # Optional. Properties defined in the Apigee organization profile. diff --git a/docs/dyn/appengine_v1.projects.locations.applications.authorizedCertificates.html b/docs/dyn/appengine_v1.projects.locations.applications.authorizedCertificates.html new file mode 100644 index 00000000000..2923e2b5917 --- /dev/null +++ b/docs/dyn/appengine_v1.projects.locations.applications.authorizedCertificates.html @@ -0,0 +1,363 @@ + + + +App Engine Admin API . projects . locations . applications . authorizedCertificates
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)Uploads the specified SSL certificate.
++
+delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)Deletes the specified SSL certificate.
++
+get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)Gets the specified SSL certificate.
+ +Lists all SSL certificates the user is authorized to administer.
+ +Retrieves the next page of results.
+ +Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)+Uploads the specified SSL certificate. + +Args: + projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) + locationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + body: object, The request body. + The object takes the form of: + +{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+++ +delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)+Deletes the specified SSL certificate. + +Args: + projectsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)+Gets the specified SSL certificate. + +Args: + projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + view: string, Controls the set of fields returned in the GET response. + Allowed values + BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date. + FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+++ +list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None)+Lists all SSL certificates the user is authorized to administer. + +Args: + projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) + locationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + pageSize: integer, Maximum results to return per page. + pageToken: string, Continuation token for fetching the next page of results. + view: string, Controls the set of fields returned in the LIST response. + Allowed values + BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date. + FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped. + 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 AuthorizedCertificates.ListAuthorizedCertificates. + "certificates": [ # The SSL certificates the user is authorized to administer. + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], + }, + ], + "nextPageToken": "A String", # Continuation token for fetching the next page of results. +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1.projects.locations.applications.html b/docs/dyn/appengine_v1.projects.locations.applications.html index 2635e648eb2..e7dd6fbd1a8 100644 --- a/docs/dyn/appengine_v1.projects.locations.applications.html +++ b/docs/dyn/appengine_v1.projects.locations.applications.html @@ -74,6 +74,11 @@patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None)+Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. + +Args: + projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + body: object, The request body. + The object takes the form of: + +{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +} + + updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+App Engine Admin API . projects . locations . applications
Instance Methods
+ +Returns the authorizedCertificates Resource.
+ diff --git a/docs/dyn/appengine_v1alpha.projects.locations.applications.authorizedCertificates.html b/docs/dyn/appengine_v1alpha.projects.locations.applications.authorizedCertificates.html new file mode 100644 index 00000000000..9b1e0c44b82 --- /dev/null +++ b/docs/dyn/appengine_v1alpha.projects.locations.applications.authorizedCertificates.html @@ -0,0 +1,363 @@ + + + +App Engine Admin API . projects . locations . applications . authorizedCertificates
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)Uploads the specified SSL certificate.
++
+delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)Deletes the specified SSL certificate.
++
+get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)Gets the specified SSL certificate.
+ +Lists all SSL certificates the user is authorized to administer.
+ +Retrieves the next page of results.
+ +Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)+Uploads the specified SSL certificate. + +Args: + projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) + locationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + body: object, The request body. + The object takes the form of: + +{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+++ +delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)+Deletes the specified SSL certificate. + +Args: + projectsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)+Gets the specified SSL certificate. + +Args: + projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + view: string, Controls the set of fields returned in the GET response. + Allowed values + BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date. + FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+++ +list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None)+Lists all SSL certificates the user is authorized to administer. + +Args: + projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) + locationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + pageSize: integer, Maximum results to return per page. + pageToken: string, Continuation token for fetching the next page of results. + view: string, Controls the set of fields returned in the LIST response. + Allowed values + BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date. + FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped. + 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 AuthorizedCertificates.ListAuthorizedCertificates. + "certificates": [ # The SSL certificates the user is authorized to administer. + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], + }, + ], + "nextPageToken": "A String", # Continuation token for fetching the next page of results. +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1alpha.projects.locations.applications.html b/docs/dyn/appengine_v1alpha.projects.locations.applications.html index d138ba69ada..ba85f113f75 100644 --- a/docs/dyn/appengine_v1alpha.projects.locations.applications.html +++ b/docs/dyn/appengine_v1alpha.projects.locations.applications.html @@ -74,6 +74,11 @@patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None)+Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. + +Args: + projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + body: object, The request body. + The object takes the form of: + +{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +} + + updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+App Engine Admin API . projects . locations . applications
Instance Methods
+ +Returns the authorizedCertificates Resource.
+ diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.authorizedCertificates.html b/docs/dyn/appengine_v1beta.projects.locations.applications.authorizedCertificates.html new file mode 100644 index 00000000000..58f0236243f --- /dev/null +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.authorizedCertificates.html @@ -0,0 +1,363 @@ + + + +App Engine Admin API . projects . locations . applications . authorizedCertificates
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)Uploads the specified SSL certificate.
++
+delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)Deletes the specified SSL certificate.
++
+get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)Gets the specified SSL certificate.
+ +Lists all SSL certificates the user is authorized to administer.
+ +Retrieves the next page of results.
+ +Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(projectsId, locationsId, applicationsId, body=None, x__xgafv=None)+Uploads the specified SSL certificate. + +Args: + projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) + locationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + body: object, The request body. + The object takes the form of: + +{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+++ +delete(projectsId, locationsId, applicationsId, authorizedCertificatesId, x__xgafv=None)+Deletes the specified SSL certificate. + +Args: + projectsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(projectsId, locationsId, applicationsId, authorizedCertificatesId, view=None, x__xgafv=None)+Gets the specified SSL certificate. + +Args: + projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + view: string, Controls the set of fields returned in the GET response. + Allowed values + BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date. + FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+++ +list(projectsId, locationsId, applicationsId, pageSize=None, pageToken=None, view=None, x__xgafv=None)+Lists all SSL certificates the user is authorized to administer. + +Args: + projectsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) + locationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `parent`. See documentation of `projectsId`. (required) + pageSize: integer, Maximum results to return per page. + pageToken: string, Continuation token for fetching the next page of results. + view: string, Controls the set of fields returned in the LIST response. + Allowed values + BASIC_CERTIFICATE - Basic certificate information, including applicable domains and expiration date. + FULL_CERTIFICATE - The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped. + 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 AuthorizedCertificates.ListAuthorizedCertificates. + "certificates": [ # The SSL certificates the user is authorized to administer. + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], + }, + ], + "nextPageToken": "A String", # Continuation token for fetching the next page of results. +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.html b/docs/dyn/appengine_v1beta.projects.locations.applications.html index 09e8377b03e..9c31890d9a1 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.applications.html +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.html @@ -74,6 +74,11 @@patch(projectsId, locationsId, applicationsId, authorizedCertificatesId, body=None, updateMask=None, x__xgafv=None)+Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. + +Args: + projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required) + locationsId: string, Part of `name`. See documentation of `projectsId`. (required) + applicationsId: string, Part of `name`. See documentation of `projectsId`. (required) + authorizedCertificatesId: string, Part of `name`. See documentation of `projectsId`. (required) + body: object, The request body. + The object takes the form of: + +{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +} + + updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains. + "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority. + "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly + "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- + }, + "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. + "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly + "A String", + ], + "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly + "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly + "managedCertificate": { # A certificate managed by App Engine. # Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly + "lastRenewalTime": "A String", # Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly + "status": "A String", # Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly + }, + "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly + "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly + "A String", + ], +}+App Engine Admin API . projects . locations . applications
Instance Methods
+ +Returns the authorizedCertificates Resource.
+ diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html index ee1e865f19d..ae7654c93f4 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html @@ -115,6 +115,8 @@Method Details
{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} @@ -223,6 +225,8 @@Method Details
{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} @@ -270,6 +274,8 @@Method Details
"backupPlanAssociations": [ # The list of Backup Plan Associations in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. { # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} @@ -327,6 +333,8 @@Method Details
{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc "backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} + "backupPlanRevisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "backupPlanRevisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "createTime": "A String", # Output only. The time when the instance was created. "dataSource": "A String", # Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index 3b2f1eb5ccb..f87669065ac 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -74,6 +74,11 @@Backup and DR Service API . projects . locations . backupPlans
Instance Methods
++
+revisions()+Returns the revisions Resource.
+Close httplib2 connections.
@@ -92,6 +97,9 @@Instance Methods
Retrieves the next page of results.
++
+patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)Update a BackupPlan
Method Details
+close()@@ -146,6 +154,8 @@Method Details
}, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "state": "A String", # Output only. The `State` for the `BackupPlan`. "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. "A String", @@ -273,6 +283,8 @@Method Details
}, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "state": "A String", # Output only. The `State` for the `BackupPlan`. "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. "A String", @@ -340,6 +352,8 @@Method Details
}, "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` "state": "A String", # Output only. The `State` for the `BackupPlan`. "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. "A String", @@ -368,4 +382,92 @@Method Details
++patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)+Update a BackupPlan + +Args: + name: string, Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (required) + body: object, The request body. + The object takes the form of: + +{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. + "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message. + { # `BackupRule` binds the backup schedule to a retention policy. + "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 186 for daily backups. Minimum value is 7 and maximum value is 366 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups. + "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/. + "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Optional. Defines a schedule that runs within the confines of a defined window of time. + "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window. + "endHourOfDay": 42, # Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00. + "startHourOfDay": 42, # Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00. + }, + "daysOfMonth": [ # Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied. + 42, + ], + "daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. + "A String", + ], + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). + "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. + "A String", + ], + "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule. + "timeZone": "A String", # Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris. + "weekDayOfMonth": { # `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. # Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied. + "dayOfWeek": "A String", # Required. Specifies the day of the week. + "weekOfMonth": "A String", # Required. Specifies the week of the month. + }, + }, + }, + ], + "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A String", # Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + "createTime": "A String", # Output only. When the `BackupPlan` was created. + "description": "A String", # Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + "etag": "A String", # Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. + "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. + "a_key": "A String", + }, + "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + "resourceType": "A String", # Required. + "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc. + "revisionName": "A String", # Output only. The resource id of the `BackupPlanRevision`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}` + "state": "A String", # Output only. The `State` for the `BackupPlan`. + "supportedResourceTypes": [ # Output only. All resource types to which backupPlan can be applied. + "A String", + ], + "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. +} + + requestId: string, Optional. 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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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, Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules. + 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. + }, +}+