Returns the organizations Resource.
+
+ permissions()
+
Returns the permissions Resource.
+ diff --git a/docs/dyn/accesscontextmanager_v1.permissions.html b/docs/dyn/accesscontextmanager_v1.permissions.html new file mode 100644 index 00000000000..9a5f20eaf0f --- /dev/null +++ b/docs/dyn/accesscontextmanager_v1.permissions.html @@ -0,0 +1,129 @@ + + + +
+ close()
Close httplib2 connections.
+
+ list(pageSize=None, pageToken=None, x__xgafv=None)
Lists all supported permissions in VPCSC Granular Controls.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all supported permissions in VPCSC Granular Controls.
+
+Args:
+ pageSize: integer, Optional. This flag specifies the maximum number of services to return per page. Default is 100.
+ pageToken: string, Optional. Token to start on a later page. Default is the first page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A response to `ListSupportedPermissionsRequest`.
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
+ "supportedPermissions": [ # List of VPC-SC supported permissions.
+ "A String",
+ ],
+}
+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. ++
Close httplib2 connections.
+ +Counts ChromeOS devices matching the request.
issueCommand(customerId, deviceId, body=None, x__xgafv=None)
Issues a command for the device to execute.
@@ -139,6 +142,28 @@Close httplib2 connections.+
countChromeOsDevices(customerId, filter=None, includeChildOrgunits=None, orgUnitPath=None, x__xgafv=None)
+ Counts ChromeOS devices matching the request.
+
+Args:
+ customerId: string, Required. Immutable ID of the Google Workspace account. (required)
+ filter: string, Optional. Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators
+ includeChildOrgunits: boolean, Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.
+ orgUnitPath: string, Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A response for counting ChromeOS devices.
+ "count": "A String", # The total number of devices matching the request.
+}
+issueCommand(customerId, deviceId, body=None, x__xgafv=None)
Issues a command for the device to execute. diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html index 344de826e32..6e396709d25 100644 --- a/docs/dyn/admin_reports_v1.activities.html +++ b/docs/dyn/admin_reports_v1.activities.html @@ -78,7 +78,7 @@Instance Methods
close()Close httplib2 connections.
+list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.
@@ -93,7 +93,7 @@Method Details
list(userKey, applicationName, actorIpAddress=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, x__xgafv=None)
+ list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)
Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. Args: @@ -139,16 +139,19 @@Method Details
takeout - The Takeout application's activity reports return information about various types of Takeout activity events. graduation - The Graduation application's activity reports return information about various types of Graduation activity events. actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. + applicationInfoFilter: string, Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` customerId: string, The unique ID of the customer to retrieve data for. endTime: string, Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days. eventName: string, The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`. filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned. groupIdFilter: string, Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175) maxResults: integer, Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000. + networkInfoFilter: string, Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode="IN" GET...&networkInfoFilter=regionCode=%22IN%22 ``` orgUnitID: string, ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results. pageToken: string, The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string. resourceDetailsFilter: string, Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields manipulated by relational operators. Resource Details Filters are in the form `{resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}...` All the inner fields are traversed using the `.` operator, as shown in the following example: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ``` `resourceDetailsFilter` query supports these relational operators: * `=`—'equal to'. * `!=`—'not equal to'. * `:`—'exists'. This is used for filtering on repeated fields. [`FieldValue`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#selectionlistvalue) contains `selection_id`: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" AND resourceDetails.appliedLabels.fieldValue.type = "SELECTION_LIST_VALUE" AND resourceDetails.appliedLabels.fieldValue.selectionListValue.id: "id" ``` **Usage** ``` GET...&resourceDetailsFilter=resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" GET...&resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22 ``` **Note the following**: * You must URL encode the query string before sending the request. * The API supports a maximum of 5 fields separated by the AND operator. - When filtering on deeper levels (e.g., [`AppliedLabel`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#appliedlabel) ID and resourceDetails ID to be present. *Sample Query*: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ``` * Filtering on inner [`FieldValue`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported. startTime: string, Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days. + statusFilter: string, Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode="200" GET...&statusFilter=statusCode=%22200%22 ``` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -233,6 +236,12 @@Method Details
"resourceIds": [ # Resource ids associated with the event. "A String", ], + "status": { # Status of the event. Note: Not all events have status. # Status of the event. Note: Not all events have status. + "errorCode": "A String", # Error code of the event. Note: Field can be empty. + "errorMessage": "A String", # Error message of the event. Note: Field can be empty. + "eventStatus": "A String", # * Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS - SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED + "httpStatusCode": 42, # Status code of the event. Note: Field can be empty. + }, "type": "A String", # Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`. }, ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index af0149f2dd0..7ddaef75712 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -124,12 +124,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -267,12 +285,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -410,12 +446,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -553,12 +607,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -738,12 +810,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -881,12 +971,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -1037,12 +1145,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, @@ -1180,12 +1306,30 @@Method Details
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, diff --git a/docs/dyn/aiplatform_v1beta1.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.html new file mode 100644 index 00000000000..10a347b8bd2 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.html @@ -0,0 +1,91 @@ + + + +Vertex AI API . evaluationMetrics
+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.evaluationMetrics.operations.html b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.operations.html new file mode 100644 index 00000000000..c6f30a1c1b5 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.operations.html @@ -0,0 +1,212 @@ + + + +close()+Close httplib2 connections.+Vertex AI API . evaluationMetrics . operations
+Instance Methods
++
+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.
++
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+Method Details
+++ +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. + }, +}+++ +list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + +Args: + name: string, The name of the operation's parent resource. (required) + filter: string, The standard list filter. + pageSize: integer, The standard list page size. + pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for Operations.ListOperations. + "nextPageToken": "A String", # The standard List next-page token. + "operations": [ # A list of operations that matches the specified filter in the request. + { # 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. + }, + }, + ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "A String", + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index ef3684c28eb..257e447cd8d 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -124,6 +124,11 @@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. ++Instance Methods
Returns the evaluationItems Resource.
+ +Returns the evaluationMetrics Resource.
+ diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index cfa86213f26..06d6ae25947 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -362,6 +362,10 @@Method Details
"a_key": "A String", }, "model": "A String", # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. "category": "A String", # Required. The harm category to be blocked. @@ -931,6 +935,10 @@Method Details
"a_key": "A String", }, "model": "A String", # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. "category": "A String", # Required. The harm category to be blocked. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index e857edeed44..b6acf134a08 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -666,6 +666,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -1286,6 +1295,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -2576,6 +2594,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -3196,6 +3223,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -4486,6 +4522,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -5106,6 +5151,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -6396,6 +6450,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -7016,6 +7079,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -8348,6 +8420,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -8968,6 +9049,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -10258,6 +10348,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -10878,6 +10977,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -12181,6 +12289,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -12801,6 +12918,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -14091,6 +14217,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. @@ -14711,6 +14846,15 @@Method Details
], }, "candidate": "A String", # Required. The name of the candidate that produced the response. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent. + "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. + }, "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html new file mode 100644 index 00000000000..831f99dacd8 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html @@ -0,0 +1,91 @@ + + + +Vertex AI API . projects . locations . evaluationMetrics
+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.evaluationMetrics.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html new file mode 100644 index 00000000000..228e39e4157 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html @@ -0,0 +1,212 @@ + + + +close()+Close httplib2 connections.+Vertex AI API . projects . locations . evaluationMetrics . operations
+Instance Methods
++
+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.
++
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+Method Details
+++ +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. + }, +}+++ +list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + +Args: + name: string, The name of the operation's parent resource. (required) + filter: string, The standard list filter. + pageSize: integer, The standard list page size. + pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for Operations.ListOperations. + "nextPageToken": "A String", # The standard List next-page token. + "operations": [ # A list of operations that matches the specified filter in the request. + { # 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. + }, + }, + ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "A String", + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index d37a72f3400..54f2afa50e0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -129,6 +129,11 @@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. ++Instance Methods
Returns the evaluationItems Resource.
+ +Returns the evaluationMetrics Resource.
+ diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index 66922640767..414075a555e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -816,6 +816,7 @@Method Details
"runResponse": "A String", # The response of the scheduled run. "scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule. }, + "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. "maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). "maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. "name": "A String", # Immutable. The resource name of the Schedule. @@ -1529,6 +1530,7 @@Method Details
"runResponse": "A String", # The response of the scheduled run. "scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule. }, + "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. "maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). "maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. "name": "A String", # Immutable. The resource name of the Schedule. @@ -2284,6 +2286,7 @@Method Details
"runResponse": "A String", # The response of the scheduled run. "scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule. }, + "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. "maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). "maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. "name": "A String", # Immutable. The resource name of the Schedule. @@ -3011,6 +3014,7 @@Method Details
"runResponse": "A String", # The response of the scheduled run. "scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule. }, + "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. "maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). "maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. "name": "A String", # Immutable. The resource name of the Schedule. @@ -3742,6 +3746,7 @@Method Details
"runResponse": "A String", # The response of the scheduled run. "scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule. }, + "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. "maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). "maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. "name": "A String", # Immutable. The resource name of the Schedule. @@ -4456,6 +4461,7 @@Method Details
"runResponse": "A String", # The response of the scheduled run. "scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule. }, + "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. "maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). "maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. "name": "A String", # Immutable. The resource name of the Schedule. diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 0c8e0ae5787..6d2d00b7a75 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -166,7 +166,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -323,7 +323,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -571,7 +571,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -775,7 +775,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -921,7 +921,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 7fac1fc332b..a00f2a8d032 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -172,7 +172,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -362,7 +362,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -643,7 +643,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -884,7 +884,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -1063,7 +1063,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index 3644aa09d7b..ec0f539ca99 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -172,7 +172,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -361,7 +361,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -641,7 +641,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -881,7 +881,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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. @@ -1059,7 +1059,7 @@Method Details
"maintenanceVersionName": "A String", # Output only. Maintenance version of the instance, for example: POSTGRES_15.2025_07_15.04_00. Output only. Update this field via the parent cluster's maintenance_version field(s). "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://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])?. + "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](https://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/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index 8fb27656b7c..80d47d3e0c1 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -330,11 +330,11 @@Method Details
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212. "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. - "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6. + { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above. + "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15. "carrierName": "A String", # The carrier name associated with this SIM card. - "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15. "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, @@ -762,11 +762,11 @@Method Details
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212. "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. - "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6. + { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above. + "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15. "carrierName": "A String", # The carrier name associated with this SIM card. - "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15. "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, @@ -1062,11 +1062,11 @@Method Details
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212. "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. - "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6. + { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above. + "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15. "carrierName": "A String", # The carrier name associated with this SIM card. - "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15. "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, @@ -1344,11 +1344,11 @@Method Details
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212. "meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1. "networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone. - "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23. - "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6. + { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above. + "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15. "carrierName": "A String", # The carrier name associated with this SIM card. - "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35. + "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15. "iccId": "A String", # Output only. The ICCID associated with this SIM card. "phoneNumber": "A String", # The phone number associated with this SIM card. }, diff --git a/docs/dyn/androidmanagement_v1.enterprises.html b/docs/dyn/androidmanagement_v1.enterprises.html index 8179f9a8d4c..013960599bb 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.html +++ b/docs/dyn/androidmanagement_v1.enterprises.html @@ -164,7 +164,7 @@Method Details
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters. "enterpriseType": "A String", # Output only. The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication. - "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. + "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. This value is overridden by EnrollmentToken.googleAuthenticationOptions and SigninDetail.googleAuthenticationOptions, if they are set. }, "logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. @@ -232,7 +232,7 @@Method Details
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters. "enterpriseType": "A String", # Output only. The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication. - "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. + "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. This value is overridden by EnrollmentToken.googleAuthenticationOptions and SigninDetail.googleAuthenticationOptions, if they are set. }, "logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. @@ -350,7 +350,7 @@Method Details
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters. "enterpriseType": "A String", # Output only. The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication. - "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. + "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. This value is overridden by EnrollmentToken.googleAuthenticationOptions and SigninDetail.googleAuthenticationOptions, if they are set. }, "logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. @@ -429,7 +429,7 @@Method Details
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters. "enterpriseType": "A String", # Output only. The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication. - "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. + "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. This value is overridden by EnrollmentToken.googleAuthenticationOptions and SigninDetail.googleAuthenticationOptions, if they are set. }, "logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. @@ -512,7 +512,7 @@Method Details
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters. "enterpriseType": "A String", # Output only. The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication. - "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. + "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. This value is overridden by EnrollmentToken.googleAuthenticationOptions and SigninDetail.googleAuthenticationOptions, if they are set. }, "logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. @@ -577,7 +577,7 @@Method Details
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters. "enterpriseType": "A String", # Output only. The type of the enterprise. "googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication. - "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. + "googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url. This value is overridden by EnrollmentToken.googleAuthenticationOptions and SigninDetail.googleAuthenticationOptions, if they are set. }, "logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. diff --git a/docs/dyn/apigee_v1.organizations.securityAssessmentResults.html b/docs/dyn/apigee_v1.organizations.securityAssessmentResults.html index c2c750f0c0b..1f6e058df61 100644 --- a/docs/dyn/apigee_v1.organizations.securityAssessmentResults.html +++ b/docs/dyn/apigee_v1.organizations.securityAssessmentResults.html @@ -151,6 +151,7 @@Method Details
"resourceUri": "A String", # The resource uri for the API Hub deployment. "sourceProject": "A String", # The source project for the API Hub deployment. }, + "apiHubGatewayType": "A String", # Optional. "name": "A String", # Required. Name of this resource. For an Apigee API Proxy, this should be the id of the API proxy. For an API Hub Deployment, this should be the id of the deployment. "resourceRevisionId": "A String", # The revision id for the resource. In case of Apigee, this is proxy revision id. "type": "A String", # Required. Type of this resource. diff --git a/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html b/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html index 220295daea9..642bccc27e4 100644 --- a/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html +++ b/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html @@ -81,13 +81,13 @@Instance Methods
create(parent, body=None, securityMonitoringConditionId=None, x__xgafv=None)Create a security monitoring condition.
+delete(name, riskAssessmentType=None, x__xgafv=None)Delete a security monitoring condition.
+get(name, riskAssessmentType=None, x__xgafv=None)Get a security monitoring condition.
-
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)list(parent, filter=None, pageSize=None, pageToken=None, riskAssessmentType=None, x__xgafv=None)List security monitoring conditions.
@@ -111,6 +111,7 @@Method Details
The object takes the form of: { # Security monitoring condition for risk assessment version 2. + "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` "createTime": "A String", # Output only. The time of the security monitoring condition creation. "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources. "resources": [ # Required. The array of resources. For Apigee, the proxies are resources. @@ -124,7 +125,8 @@Method Details
}, "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition} "profile": "A String", # Required. ID of security profile of the security monitoring condition. - "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources. + "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY. + "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set. "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope. "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition. "updateTime": "A String", # Output only. The time of the security monitoring condition update. @@ -140,6 +142,7 @@Method Details
An object of the form: { # Security monitoring condition for risk assessment version 2. + "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` "createTime": "A String", # Output only. The time of the security monitoring condition creation. "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources. "resources": [ # Required. The array of resources. For Apigee, the proxies are resources. @@ -153,7 +156,8 @@Method Details
}, "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition} "profile": "A String", # Required. ID of security profile of the security monitoring condition. - "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources. + "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY. + "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set. "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope. "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition. "updateTime": "A String", # Output only. The time of the security monitoring condition update. @@ -161,11 +165,16 @@Method Details
delete(name, x__xgafv=None)
+ delete(name, riskAssessmentType=None, x__xgafv=None)
Delete a security monitoring condition.
Args:
name: string, Required. The name of the security monitoring condition to delete. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
+ riskAssessmentType: string, Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ Allowed values
+ RISK_ASSESSMENT_TYPE_UNSPECIFIED - Risk assessment type is not specified.
+ APIGEE - Risk assessment type is Apigee.
+ API_HUB - Risk assessment type is API Hub.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -179,11 +188,16 @@ Method Details
get(name, x__xgafv=None)
+ get(name, riskAssessmentType=None, x__xgafv=None)
Get a security monitoring condition.
Args:
name: string, Required. The name of the security monitoring condition to get. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
+ riskAssessmentType: string, Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ Allowed values
+ RISK_ASSESSMENT_TYPE_UNSPECIFIED - Risk assessment type is not specified.
+ APIGEE - Risk assessment type is Apigee.
+ API_HUB - Risk assessment type is API Hub.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -193,6 +207,7 @@ Method Details
An object of the form:
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -206,7 +221,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
@@ -214,14 +230,19 @@ Method Details
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, filter=None, pageSize=None, pageToken=None, riskAssessmentType=None, x__xgafv=None)
List security monitoring conditions.
Args:
parent: string, Required. For a specific organization, list all the security monitoring conditions. Format: `organizations/{org}` (required)
- filter: string, Optional. Filter for the monitoring conditions. For example: `profile=profile1 AND scope=env1`
+ filter: string, Optional. Filter for the monitoring conditions. When RiskAssessmentType is APIGEE, monitoring conditions can be filtered by profile and scope. For example: `profile=profile1 AND scope=env1` When RiskAssessmentType is API_HUB, monitoring conditions can be filtered by profile and api_hub_gateway. For example: `profile=profile1 AND api_hub_gateway=gateway1`
pageSize: integer, Optional. The maximum number of monitoring conditions to return.
pageToken: string, Optional. A page token, received from a previous `ListSecurityMonitoringConditions` call. Provide this to retrieve the subsequent page.
+ riskAssessmentType: string, Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ Allowed values
+ RISK_ASSESSMENT_TYPE_UNSPECIFIED - Risk assessment type is not specified.
+ APIGEE - Risk assessment type is Apigee.
+ API_HUB - Risk assessment type is API Hub.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -234,6 +255,7 @@ Method Details
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"securityMonitoringConditions": [ # List of security monitoring conditions in the organization.
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -247,7 +269,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
@@ -280,6 +303,7 @@ Method Details
The object takes the form of:
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -293,7 +317,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
@@ -309,6 +334,7 @@ Method Details
An object of the form:
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -322,7 +348,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html
index 7c77f467c2b..edbbdac8d8f 100644
--- a/docs/dyn/apihub_v1.projects.locations.html
+++ b/docs/dyn/apihub_v1.projects.locations.html
@@ -150,7 +150,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -1057,7 +1057,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html
index e45c4b630ba..79036421cf3 100644
--- a/docs/dyn/appengine_v1beta.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta.apps.services.versions.html
@@ -354,18 +354,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
@@ -700,18 +688,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
@@ -980,18 +956,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
@@ -1263,18 +1227,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html
index 987234bb74c..7b9f692fe1c 100644
--- a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html
+++ b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html
@@ -384,18 +384,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
diff --git a/docs/dyn/apphub_v1.projects.locations.html b/docs/dyn/apphub_v1.projects.locations.html
index de327e9c846..5a51437375e 100644
--- a/docs/dyn/apphub_v1.projects.locations.html
+++ b/docs/dyn/apphub_v1.projects.locations.html
@@ -118,7 +118,7 @@ Instance Methods
Gets a Boundary.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -210,7 +210,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.html b/docs/dyn/apphub_v1alpha.projects.locations.html
index 57b3b9beef5..63ce8ef065e 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.html
@@ -118,7 +118,7 @@ Instance Methods
Gets a Boundary.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -210,7 +210,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/appsmarket_v2.customerLicense.html b/docs/dyn/appsmarket_v2.customerLicense.html
index d87522e25c3..062fd935cdf 100644
--- a/docs/dyn/appsmarket_v2.customerLicense.html
+++ b/docs/dyn/appsmarket_v2.customerLicense.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
get(applicationId, customerId, x__xgafv=None)
-Gets the status of a license for a customer to determine if they have access for a given app.
+Gets the customer's licensing status to determine if they have access to a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).
Method Details
close()
@@ -88,11 +88,11 @@ Method Details
get(applicationId, customerId, x__xgafv=None)
- Gets the status of a license for a customer to determine if they have access for a given app.
+ Gets the customer's licensing status to determine if they have access to a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).
Args:
- applicationId: string, Application Id (required)
- customerId: string, Customer Id (required)
+ applicationId: string, The ID of the application. (required)
+ customerId: string, The ID of the customer. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -112,8 +112,8 @@ Method Details
},
],
"id": "A String", # The ID of the customer license.
- "kind": "A String", # The type of API resource. This is always appsmarket#customerLicense.
- "state": "A String", # The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license: either this customer has never installed your application, or else has deleted it.
+ "kind": "A String", # The type of API resource. This is always `appsmarket#customerLicense`.
+ "state": "A String", # The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license. Either this customer has never installed your application or has deleted it.
}
diff --git a/docs/dyn/appsmarket_v2.userLicense.html b/docs/dyn/appsmarket_v2.userLicense.html
index 26d14012c12..c90e56644d2 100644
--- a/docs/dyn/appsmarket_v2.userLicense.html
+++ b/docs/dyn/appsmarket_v2.userLicense.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
get(applicationId, userId, x__xgafv=None)
-Gets the user's licensing status for their permission to use a given app.
+Gets the user's licensing status to determine if they have permission to use a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).
Method Details
close()
@@ -88,11 +88,11 @@ Method Details
get(applicationId, userId, x__xgafv=None)
- Gets the user's licensing status for their permission to use a given app.
+ Gets the user's licensing status to determine if they have permission to use a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).
Args:
- applicationId: string, Application Id (required)
- userId: string, User Id (required)
+ applicationId: string, The ID of the application. (required)
+ userId: string, The ID of the user. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -106,8 +106,8 @@ Method Details
"customerId": "A String", # The domain name of the user.
"editionId": "A String", # (Deprecated)
"enabled": True or False, # The domain administrator has activated the application for this domain.
- "id": "A String", # The ID of user license.
- "kind": "A String", # The type of API resource. This is always appsmarket#userLicense.
+ "id": "A String", # The ID of the user license.
+ "kind": "A String", # The type of API resource. This is always `appsmarket#userLicense`.
"state": "A String", # The user's licensing status. One of: - `ACTIVE`: The user has a valid license and should be permitted to use the application. - `UNLICENSED`: The administrator of this user's domain never assigned a seat for the application to this user. - `EXPIRED`: The administrator assigned a seat to this user, but the license is expired.
"userId": "A String", # The email address of the user.
}
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.html b/docs/dyn/artifactregistry_v1.projects.locations.html
index ce72d9991bf..262df33e200 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.html
@@ -95,7 +95,7 @@ Instance Methods
Retrieves the VPCSC Config for the Project.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -157,7 +157,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.html
index fadb773efd7..310933b8171 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.html
@@ -92,7 +92,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -131,7 +131,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.html
index 06ad358adce..3648a39bb95 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.locations.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.html
@@ -92,7 +92,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -131,7 +131,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/biglake_v1.projects.catalogs.html b/docs/dyn/biglake_v1.projects.catalogs.html
index cb5932bea58..a4c9a012c87 100644
--- a/docs/dyn/biglake_v1.projects.catalogs.html
+++ b/docs/dyn/biglake_v1.projects.catalogs.html
@@ -88,6 +88,9 @@ Instance Methods
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the IAM policy for the specified catalog.
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
+Tests the IAM permissions for the specified catalog.
Method Details
close()
@@ -227,4 +230,34 @@ Method Details
}
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
+ Tests the IAM permissions for the specified catalog.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+}
+
+