diff --git a/Sources/GeneratedServices/APIGateway/Public/GoogleAPIClientForREST/GTLRAPIGatewayQuery.h b/Sources/GeneratedServices/APIGateway/Public/GoogleAPIClientForREST/GTLRAPIGatewayQuery.h index a19ace342..ab9ae62ee 100644 --- a/Sources/GeneratedServices/APIGateway/Public/GoogleAPIClientForREST/GTLRAPIGatewayQuery.h +++ b/Sources/GeneratedServices/APIGateway/Public/GoogleAPIClientForREST/GTLRAPIGatewayQuery.h @@ -1065,8 +1065,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAPIGatewayViewFull; @interface GTLRAPIGatewayQuery_ProjectsLocationsList : GTLRAPIGatewayQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/APIManagement/GTLRAPIManagementObjects.m b/Sources/GeneratedServices/APIManagement/GTLRAPIManagementObjects.m index a42c366a3..2a86597f2 100644 --- a/Sources/GeneratedServices/APIManagement/GTLRAPIManagementObjects.m +++ b/Sources/GeneratedServices/APIManagement/GTLRAPIManagementObjects.m @@ -498,11 +498,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRAPIManagement_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRAPIManagement_Operation class] + @"operations" : [GTLRAPIManagement_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/APIManagement/GTLRAPIManagementQuery.m b/Sources/GeneratedServices/APIManagement/GTLRAPIManagementQuery.m index a077e68c3..64926ef80 100644 --- a/Sources/GeneratedServices/APIManagement/GTLRAPIManagementQuery.m +++ b/Sources/GeneratedServices/APIManagement/GTLRAPIManagementQuery.m @@ -492,7 +492,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRAPIManagementQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementObjects.h b/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementObjects.h index 59995ae16..d6f9e524e 100644 --- a/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementObjects.h +++ b/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementObjects.h @@ -1015,6 +1015,13 @@ FOUNDATION_EXTERN NSString * const kGTLRAPIManagement_TagAction_Action_Remove; */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementQuery.h b/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementQuery.h index e74d31a0e..c9d7efee6 100644 --- a/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementQuery.h +++ b/Sources/GeneratedServices/APIManagement/Public/GoogleAPIClientForREST/GTLRAPIManagementQuery.h @@ -101,8 +101,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRAPIManagementQuery_ProjectsLocationsList : GTLRAPIManagementQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -933,6 +933,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRAPIManagement_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/APIhub/GTLRAPIhubObjects.m b/Sources/GeneratedServices/APIhub/GTLRAPIhubObjects.m index 937f16544..96e37507f 100644 --- a/Sources/GeneratedServices/APIhub/GTLRAPIhubObjects.m +++ b/Sources/GeneratedServices/APIhub/GTLRAPIhubObjects.m @@ -184,6 +184,18 @@ NSString * const kGTLRAPIhub_GoogleCloudApihubV1LintResponse_State_LintStateSuccess = @"LINT_STATE_SUCCESS"; NSString * const kGTLRAPIhub_GoogleCloudApihubV1LintResponse_State_LintStateUnspecified = @"LINT_STATE_UNSPECIFIED"; +// GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest.action +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_ActionUnspecified = @"ACTION_UNSPECIFIED"; +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_Delete = @"DELETE"; +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_Upload = @"UPLOAD"; + +// GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest.dataType +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_DataTypeUnspecified = @"DATA_TYPE_UNSPECIFIED"; +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_EnvironmentManifest = @"ENVIRONMENT_MANIFEST"; +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_ProxyBundle = @"PROXY_BUNDLE"; +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_ProxyDeploymentManifest = @"PROXY_DEPLOYMENT_MANIFEST"; +NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_SharedFlowBundle = @"SHARED_FLOW_BUNDLE"; + // GTLRAPIhub_GoogleCloudApihubV1OpenApiSpecDetails.format NSString * const kGTLRAPIhub_GoogleCloudApihubV1OpenApiSpecDetails_Format_FormatUnspecified = @"FORMAT_UNSPECIFIED"; NSString * const kGTLRAPIhub_GoogleCloudApihubV1OpenApiSpecDetails_Format_OpenApiSpec20 = @"OPEN_API_SPEC_2_0"; @@ -1550,6 +1562,25 @@ @implementation GTLRAPIhub_GoogleCloudApihubV1LookupRuntimeProjectAttachmentResp @end +// ---------------------------------------------------------------------------- +// +// GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest +// + +@implementation GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest +@dynamic action, data, dataType, relativePath; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse +// + +@implementation GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse +@end + + // ---------------------------------------------------------------------------- // // GTLRAPIhub_GoogleCloudApihubV1MatchResult diff --git a/Sources/GeneratedServices/APIhub/GTLRAPIhubQuery.m b/Sources/GeneratedServices/APIhub/GTLRAPIhubQuery.m index 7fabf4d09..de9d350d4 100644 --- a/Sources/GeneratedServices/APIhub/GTLRAPIhubQuery.m +++ b/Sources/GeneratedServices/APIhub/GTLRAPIhubQuery.m @@ -1781,6 +1781,33 @@ + (instancetype)queryWithParent:(NSString *)parent { @end +@implementation GTLRAPIhubQuery_ProjectsLocationsPluginsInstancesManageSourceData + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:manageSourceData"; + GTLRAPIhubQuery_ProjectsLocationsPluginsInstancesManageSourceData *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse class]; + query.loggingName = @"apihub.projects.locations.plugins.instances.manageSourceData"; + return query; +} + +@end + @implementation GTLRAPIhubQuery_ProjectsLocationsPluginsInstancesPatch @dynamic name, updateMask; diff --git a/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubObjects.h b/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubObjects.h index b0b4c46cf..8df715738 100644 --- a/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubObjects.h +++ b/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubObjects.h @@ -954,6 +954,62 @@ FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1LintResponse_S */ FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1LintResponse_State_LintStateUnspecified; +// ---------------------------------------------------------------------------- +// GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest.action + +/** + * Default unspecified action. + * + * Value: "ACTION_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_ActionUnspecified; +/** + * Delete data. + * + * Value: "DELETE" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_Delete; +/** + * Upload or upsert data. + * + * Value: "UPLOAD" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_Upload; + +// ---------------------------------------------------------------------------- +// GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest.dataType + +/** + * Default unspecified type. + * + * Value: "DATA_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_DataTypeUnspecified; +/** + * Environment manifest. + * + * Value: "ENVIRONMENT_MANIFEST" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_EnvironmentManifest; +/** + * Proxy bundle. + * + * Value: "PROXY_BUNDLE" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_ProxyBundle; +/** + * Proxy deployment manifest. + * + * Value: "PROXY_DEPLOYMENT_MANIFEST" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_ProxyDeploymentManifest; +/** + * Shared flow bundle. + * + * Value: "SHARED_FLOW_BUNDLE" + */ +FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_SharedFlowBundle; + // ---------------------------------------------------------------------------- // GTLRAPIhub_GoogleCloudApihubV1OpenApiSpecDetails.format @@ -4136,6 +4192,64 @@ FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1SummaryEntry_S @end +/** + * The ManagePluginInstanceSourceData method's request. + */ +@interface GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest : GTLRObject + +/** + * Required. Action to be performed. + * + * Likely values: + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_ActionUnspecified + * Default unspecified action. (Value: "ACTION_UNSPECIFIED") + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_Delete + * Delete data. (Value: "DELETE") + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_Action_Upload + * Upload or upsert data. (Value: "UPLOAD") + */ +@property(nonatomic, copy, nullable) NSString *action; + +/** + * Required. Data to be managed. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). + */ +@property(nonatomic, copy, nullable) NSString *data; + +/** + * Required. Type of data to be managed. + * + * Likely values: + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_DataTypeUnspecified + * Default unspecified type. (Value: "DATA_TYPE_UNSPECIFIED") + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_EnvironmentManifest + * Environment manifest. (Value: "ENVIRONMENT_MANIFEST") + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_ProxyBundle + * Proxy bundle. (Value: "PROXY_BUNDLE") + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_ProxyDeploymentManifest + * Proxy deployment manifest. (Value: "PROXY_DEPLOYMENT_MANIFEST") + * @arg @c kGTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest_DataType_SharedFlowBundle + * Shared flow bundle. (Value: "SHARED_FLOW_BUNDLE") + */ +@property(nonatomic, copy, nullable) NSString *dataType; + +/** + * Required. Relative path of data being managed for a given plugin instance. + */ +@property(nonatomic, copy, nullable) NSString *relativePath; + +@end + + +/** + * The ManagePluginInstanceSourceData method's response. + */ +@interface GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse : GTLRObject +@end + + /** * MatchResult represents the result of matching a discovered API operation * with a catalog API operation. @@ -4390,7 +4504,11 @@ FOUNDATION_EXTERN NSString * const kGTLRAPIhub_GoogleCloudApihubV1SummaryEntry_S */ @interface GTLRAPIhub_GoogleCloudApihubV1Plugin : GTLRObject -/** Required. The configuration of actions supported by the plugin. */ +/** + * Optional. The configuration of actions supported by the plugin. + * **REQUIRED**: This field must be provided when creating or updating a + * Plugin. The server will reject requests if this field is missing. + */ @property(nonatomic, strong, nullable) NSArray *actionsConfig; /** Optional. The configuration template for the plugin. */ diff --git a/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubQuery.h b/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubQuery.h index 0de38b028..b04ac5849 100644 --- a/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubQuery.h +++ b/Sources/GeneratedServices/APIhub/Public/GoogleAPIClientForREST/GTLRAPIhubQuery.h @@ -73,7 +73,9 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Deletes the API hub instance. + * Deletes the API hub instance. Deleting the API hub instance will also result + * in the removal of all associated runtime project attachments and the host + * project registration. * * Method: apihub.projects.locations.apiHubInstances.delete * @@ -91,7 +93,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAPIhub_GoogleLongrunningOperation. * - * Deletes the API hub instance. + * Deletes the API hub instance. Deleting the API hub instance will also result + * in the removal of all associated runtime project attachments and the host + * project registration. * * @param name Required. The name of the Api Hub instance to delete. Format: * `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. @@ -3026,8 +3030,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRAPIhubQuery_ProjectsLocationsList : GTLRAPIhubQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -3743,6 +3747,43 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Manages data for a given plugin instance. + * + * Method: apihub.projects.locations.plugins.instances.manageSourceData + * + * Authorization scope(s): + * @c kGTLRAuthScopeAPIhubCloudPlatform + */ +@interface GTLRAPIhubQuery_ProjectsLocationsPluginsInstancesManageSourceData : GTLRAPIhubQuery + +/** + * Required. The name of the plugin instance for which data needs to be + * managed. Format: + * `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c + * GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataResponse. + * + * Manages data for a given plugin instance. + * + * @param object The @c + * GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest to + * include in the query. + * @param name Required. The name of the plugin instance for which data needs + * to be managed. Format: + * `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` + * + * @return GTLRAPIhubQuery_ProjectsLocationsPluginsInstancesManageSourceData + */ ++ (instancetype)queryWithObject:(GTLRAPIhub_GoogleCloudApihubV1ManagePluginInstanceSourceDataRequest *)object + name:(NSString *)name; + +@end + /** * Updates a plugin instance in the API hub. The following fields in the * plugin_instance can be updated currently: * display_name * diff --git a/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalObjects.h b/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalObjects.h index 64b2fa538..3f9d01cd3 100644 --- a/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalObjects.h +++ b/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalObjects.h @@ -87,7 +87,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_GoogleR */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_ThirdPartyDataRequest; /** - * Default value for proto, shouldn't be used. + * This value is not used. * * Value: "TYPE_UNSPECIFIED" */ @@ -97,31 +97,35 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_AccessReason_Type_TypeUns // GTLRAccessApproval_CustomerApprovalApprovalPolicy.justificationBasedApprovalPolicy /** - * Instant approval is enabled for all accesses. + * Audit-only mode. All accesses are pre-approved instantly. * * Value: "JUSTIFICATION_BASED_APPROVAL_ENABLED_ALL" */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalEnabledAll; /** - * Instant approval is enabled for external justifications. + * Customer initiated support access reasons are pre-approved instantly. All + * other accesses require customer approval. * * Value: "JUSTIFICATION_BASED_APPROVAL_ENABLED_EXTERNAL_JUSTIFICATIONS" */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalEnabledExternalJustifications; /** - * Instant approval is inherited from the parent. + * Defer configuration to parent settings. This is the default value if the + * policy is not set and the parent has a value set. * * Value: "JUSTIFICATION_BASED_APPROVAL_INHERITED" */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalInherited; /** - * Instant approval is not enabled for any accesses. + * All access approval requests require customer approval. This is the default + * value if the policy is not set. * * Value: "JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED" */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalNotEnabled; /** - * Default value for proto. + * Default value, defaults to JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED if not + * set. This value is not able to be configured by the user, do not use. * * Value: "JUSTIFICATION_BASED_APPROVAL_POLICY_UNSPECIFIED" */ @@ -137,7 +141,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_CustomerApprovalApprovalP */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_EnrolledService_EnrollmentLevel_BlockAll; /** - * Default value for proto, shouldn't be used. + * Default value if not set, defaults to "BLOCK_ALL". This value is not + * available to be set by the user, do not use. * * Value: "ENROLLMENT_LEVEL_UNSPECIFIED" */ @@ -168,7 +173,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_Settings_RequestScopeMaxW */ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_Settings_RequestScopeMaxWidthPreference_Project; /** - * Default value for proto, shouldn't be used. + * Default value, defaults to ORGANIZATION if not set. This value is not able + * to be configured by the user, do not use. * * Value: "REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED" */ @@ -441,26 +447,27 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAlgorithm_RsaSignRawPkcs14096; /** - * Home office and physical location of the principal. + * Physical assigned office and physical location of the Google administrator + * performing the access. */ @interface GTLRAccessApproval_AccessLocations : GTLRObject /** - * The "home office" location of the principal. A two-letter country code (ISO - * 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some - * limited situations Google systems may refer refer to a region code instead - * of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: - * Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: - * Antarctica * ANY: Any location + * The "home office" location of the Google administrator. A two-letter country + * code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In + * some limited situations Google systems may refer refer to a region code + * instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe + * * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * + * ANT: Antarctica * ANY: Any location */ @property(nonatomic, copy, nullable) NSString *principalOfficeCountry; /** - * Physical location of the principal at the time of the access. A two-letter - * country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region - * code. In some limited situations Google systems may refer refer to a region - * code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: - * Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South + * Physical location of the Google administrator at the time of the access. A + * two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or + * a region code. In some limited situations Google systems may refer refer to + * a region code instead of a country code. Possible Region Codes: * ASI: Asia + * * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South * America * ANT: Antarctica * ANY: Any location */ @property(nonatomic, copy, nullable) NSString *principalPhysicalLocationCountry; @@ -479,7 +486,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl @property(nonatomic, copy, nullable) NSString *detail; /** - * Type of access justification. + * Type of access reason. * * Likely values: * @arg @c kGTLRAccessApproval_AccessReason_Type_CloudInitiatedAccess Similar @@ -511,8 +518,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl * principal was compelled to access customer data in order to respond to * a legal third party data request or process, including legal processes * from customers themselves. (Value: "THIRD_PARTY_DATA_REQUEST") - * @arg @c kGTLRAccessApproval_AccessReason_Type_TypeUnspecified Default - * value for proto, shouldn't be used. (Value: "TYPE_UNSPECIFIED") + * @arg @c kGTLRAccessApproval_AccessReason_Type_TypeUnspecified This value + * is not used. (Value: "TYPE_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *type; @@ -551,7 +558,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl /** The locations for which approval is being requested. */ @property(nonatomic, strong, nullable) GTLRAccessApproval_AccessLocations *requestedLocations; -/** The justification for which approval is being requested. */ +/** The access reason for which approval is being requested. */ @property(nonatomic, strong, nullable) GTLRAccessApproval_AccessReason *requestedReason; /** @@ -622,7 +629,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl /** - * This field contains the augmented information of the request. + * This field contains the augmented information of the request. Requires + * augmented administrative access to be enabled. */ @interface GTLRAccessApproval_AugmentedInfo : GTLRObject @@ -645,20 +653,24 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl * * Likely values: * @arg @c kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalEnabledAll - * Instant approval is enabled for all accesses. (Value: + * Audit-only mode. All accesses are pre-approved instantly. (Value: * "JUSTIFICATION_BASED_APPROVAL_ENABLED_ALL") * @arg @c kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalEnabledExternalJustifications - * Instant approval is enabled for external justifications. (Value: + * Customer initiated support access reasons are pre-approved instantly. + * All other accesses require customer approval. (Value: * "JUSTIFICATION_BASED_APPROVAL_ENABLED_EXTERNAL_JUSTIFICATIONS") * @arg @c kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalInherited - * Instant approval is inherited from the parent. (Value: + * Defer configuration to parent settings. This is the default value if + * the policy is not set and the parent has a value set. (Value: * "JUSTIFICATION_BASED_APPROVAL_INHERITED") * @arg @c kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalNotEnabled - * Instant approval is not enabled for any accesses. (Value: + * All access approval requests require customer approval. This is the + * default value if the policy is not set. (Value: * "JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED") * @arg @c kGTLRAccessApproval_CustomerApprovalApprovalPolicy_JustificationBasedApprovalPolicy_JustificationBasedApprovalPolicyUnspecified - * Default value for proto. (Value: - * "JUSTIFICATION_BASED_APPROVAL_POLICY_UNSPECIFIED") + * Default value, defaults to JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED if + * not set. This value is not able to be configured by the user, do not + * use. (Value: "JUSTIFICATION_BASED_APPROVAL_POLICY_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *justificationBasedApprovalPolicy; @@ -709,28 +721,51 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl /** * The product for which Access Approval will be enrolled. Allowed values are - * listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * - * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key - * Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * - * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud - * Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * - * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes - * Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * - * Secret Manager * Speaker ID Note: These values are supported as input for - * legacy purposes, but will not be returned from the API. * all * ga-only * - * appengine.googleapis.com * artifactregistry.googleapis.com * - * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com - * * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * - * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * - * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * - * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * - * spanner.googleapis.com * secretmanager.googleapis.com * - * speakerid.googleapis.com * storage.googleapis.com Calls to - * UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com - * will be translated to the associated product name ('all', 'App Engine', - * etc.). Note: 'all' will enroll the resource in all products supported at - * both 'GA' and 'Preview' levels. More information about levels of support is - * available at + * listed below (case-sensitive): * all * GA * Access Context Manager * Anthos + * Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration + * * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * + * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and + * Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * + * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * + * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud + * Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud + * Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * + * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * + * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud + * Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * + * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * + * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * + * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build + * * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud + * Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App + * Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE + * Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud + * Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * + * Key Access Justifications * Cloud Key Management Service * Cloud Logging * + * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * + * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough + * Network Load Balancer * OIDC One * Organization Policy Service * Org + * Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * + * Regional Internal Application Load Balancer * Storage Batch Operations * + * Cloud Security Command Center * Secure Source Manager * Seeker * Service + * Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud + * Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * + * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls + * Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These + * values are supported as input for legacy purposes, but will not be returned + * from the API. * all * ga-only * appengine.googleapis.com * + * artifactregistry.googleapis.com * bigquery.googleapis.com * + * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com + * * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * + * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * + * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * + * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * + * secretmanager.googleapis.com * speakerid.googleapis.com * + * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or + * any of the XXX.googleapis.com will be translated to the associated product + * name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in + * all products supported at both 'GA' and 'Preview' levels. More information + * about levels of support is available at * https://cloud.google.com/access-approval/docs/supported-services */ @property(nonatomic, copy, nullable) NSString *cloudProduct; @@ -743,7 +778,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl * Service is enrolled in Access Approval for all requests (Value: * "BLOCK_ALL") * @arg @c kGTLRAccessApproval_EnrolledService_EnrollmentLevel_EnrollmentLevelUnspecified - * Default value for proto, shouldn't be used. (Value: + * Default value if not set, defaults to "BLOCK_ALL". This value is not + * available to be set by the user, do not use. (Value: * "ENROLLMENT_LEVEL_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *enrollmentLevel; @@ -842,12 +878,16 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl */ @property(nonatomic, strong, nullable) NSNumber *ancestorHasActiveKeyVersion; -/** Optional. Policy for approval. This contains all policies. */ +/** + * Optional. Policy configuration for Access Approval that sets the operating + * mode. The available policies are Transparency, Streamlined Support, and + * Approval Required. + */ @property(nonatomic, strong, nullable) GTLRAccessApproval_CustomerApprovalApprovalPolicy *approvalPolicy; /** - * Output only. Policy for approval included inherited settings to understand - * the exact policy applied to this resource. This is a read-only field. + * Output only. Effective policy applied for Access Approval, inclusive of + * inheritance. */ @property(nonatomic, strong, nullable) GTLRAccessApproval_CustomerApprovalApprovalPolicy *effectiveApprovalPolicy; @@ -870,8 +910,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl * individual services. If name refers to a folder or project, enrollment can * only be done on an all or nothing basis. If a cloud_product is repeated in * this list, the first entry will be honored and all following entries will be - * discarded. A maximum of 10 enrolled services will be enforced, to be - * expanded as the set of supported services is expanded. + * discarded. */ @property(nonatomic, strong, nullable) NSArray *enrolledServices; @@ -905,31 +944,34 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl @property(nonatomic, strong, nullable) NSArray *notificationEmails; /** - * Optional. A pubsub topic to which notifications relating to approval - * requests should be sent. + * Optional. A pubsub topic that notifications relating to access approval are + * published to. Notifications include pre-approved accesses. */ @property(nonatomic, copy, nullable) NSString *notificationPubsubTopic; /** - * This preference is communicated to Google personnel when sending an approval - * request but can be overridden if necessary. + * This field is used to set a preference for granularity of an access approval + * request. If true, Google personnel will be asked to send resource-level + * requests when possible. If false, Google personnel will be asked to send + * requests at the project level. * * Uses NSNumber of boolValue. */ @property(nonatomic, strong, nullable) NSNumber *preferNoBroadApprovalRequests; /** - * This preference is shared with Google personnel, but can be overridden if - * said personnel deems necessary. The approver ultimately can set the - * expiration at approval time. + * Set the default access approval request expiration time. This value is able + * to be set directly by the customer at the time of approval, overriding this + * suggested value. We recommend setting this value to 30 days. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *preferredRequestExpirationDays; /** - * Optional. A setting to indicate the maximum width of an Access Approval - * request. + * Optional. A setting that indicates the maximum scope of an Access Approval + * request: either organization, folder, or project. Google administrators will + * be asked to send requests no broader than the configured scope. * * Likely values: * @arg @c kGTLRAccessApproval_Settings_RequestScopeMaxWidthPreference_Folder @@ -943,14 +985,16 @@ FOUNDATION_EXTERN NSString * const kGTLRAccessApproval_SignatureInfo_GoogleKeyAl * Customer allows the scope of Access Approval requests as broad as the * Project level. (Value: "PROJECT") * @arg @c kGTLRAccessApproval_Settings_RequestScopeMaxWidthPreference_RequestScopeMaxWidthPreferenceUnspecified - * Default value for proto, shouldn't be used. (Value: + * Default value, defaults to ORGANIZATION if not set. This value is not + * able to be configured by the user, do not use. (Value: * "REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *requestScopeMaxWidthPreference; /** - * Optional. A setting to require approval request justifications to be - * customer visible. + * Optional. When enabled, Google will only be able to send approval requests + * for access reasons with a customer accessible case ID in the reason detail. + * Also known as "Require customer initiated support case justification" * * Uses NSNumber of boolValue. */ diff --git a/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalQuery.h b/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalQuery.h index 742bb7c4a..a016d9781 100644 --- a/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalQuery.h +++ b/Sources/GeneratedServices/AccessApproval/Public/GoogleAPIClientForREST/GTLRAccessApprovalQuery.h @@ -67,11 +67,11 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does - * not deny access to the resource if another request has been made and - * approved. It is equivalent in effect to ignoring the request altogether. - * Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION - * if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a + * request is dismissed, it is considered ignored. Dismissing a request does + * not prevent access granted by other Access Approval requests. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the + * request exists but is not in a pending state. * * Method: accessapproval.folders.approvalRequests.dismiss * @@ -86,11 +86,11 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAccessApproval_ApprovalRequest. * - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does - * not deny access to the resource if another request has been made and - * approved. It is equivalent in effect to ignoring the request altogether. - * Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION - * if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a + * request is dismissed, it is considered ignored. Dismissing a request does + * not prevent access granted by other Access Approval requests. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the + * request exists but is not in a pending state. * * @param object The @c GTLRAccessApproval_DismissApprovalRequestMessage to * include in the query. @@ -135,10 +135,10 @@ NS_ASSUME_NONNULL_BEGIN /** * Invalidates an existing ApprovalRequest. Returns the updated - * ApprovalRequest. NOTE: This does not deny access to the resource if another - * request has been made and approved. It only invalidates a single approval. - * Returns FAILED_PRECONDITION if the request exists but is not in an approved - * state. + * ApprovalRequest. NOTE: This action revokes Google access based on this + * approval request. If the resource has other active approvals, access will + * remain granted. Returns FAILED_PRECONDITION if the request exists but is not + * in an approved state. * * Method: accessapproval.folders.approvalRequests.invalidate * @@ -154,10 +154,10 @@ NS_ASSUME_NONNULL_BEGIN * Fetches a @c GTLRAccessApproval_ApprovalRequest. * * Invalidates an existing ApprovalRequest. Returns the updated - * ApprovalRequest. NOTE: This does not deny access to the resource if another - * request has been made and approved. It only invalidates a single approval. - * Returns FAILED_PRECONDITION if the request exists but is not in an approved - * state. + * ApprovalRequest. NOTE: This action revokes Google access based on this + * approval request. If the resource has other active approvals, access will + * remain granted. Returns FAILED_PRECONDITION if the request exists but is not + * in an approved state. * * @param object The @c GTLRAccessApproval_InvalidateApprovalRequestMessage to * include in the query. @@ -227,11 +227,10 @@ NS_ASSUME_NONNULL_BEGIN /** * Deletes the settings associated with a project, folder, or organization. - * This will have the effect of disabling Access Approval for the project, - * folder, or organization, but only if all ancestors also have Access Approval - * disabled. If Access Approval is enabled at a higher level of the hierarchy, - * then Access Approval will still be enabled at this level as the settings are - * inherited. + * This will have the effect of disabling Access Approval for the resource. + * Access Approval may remain active based on parent resource settings. To + * confirm the effective settings, call GetAccessApprovalSettings and verify + * effective setting is disabled. * * Method: accessapproval.folders.deleteAccessApprovalSettings * @@ -247,11 +246,10 @@ NS_ASSUME_NONNULL_BEGIN * Fetches a @c GTLRAccessApproval_Empty. * * Deletes the settings associated with a project, folder, or organization. - * This will have the effect of disabling Access Approval for the project, - * folder, or organization, but only if all ancestors also have Access Approval - * disabled. If Access Approval is enabled at a higher level of the hierarchy, - * then Access Approval will still be enabled at this level as the settings are - * inherited. + * This will have the effect of disabling Access Approval for the resource. + * Access Approval may remain active based on parent resource settings. To + * confirm the effective settings, call GetAccessApprovalSettings and verify + * effective setting is disabled. * * @param name Name of the AccessApprovalSettings to delete. * @@ -262,7 +260,8 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or + * organization. * * Method: accessapproval.folders.getAccessApprovalSettings * @@ -280,7 +279,8 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAccessApproval_Settings. * - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or + * organization. * * @param name The name of the AccessApprovalSettings to retrieve. Format: * "{projects|folders|organizations}/{id}/accessApprovalSettings" @@ -405,11 +405,11 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does - * not deny access to the resource if another request has been made and - * approved. It is equivalent in effect to ignoring the request altogether. - * Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION - * if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a + * request is dismissed, it is considered ignored. Dismissing a request does + * not prevent access granted by other Access Approval requests. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the + * request exists but is not in a pending state. * * Method: accessapproval.organizations.approvalRequests.dismiss * @@ -424,11 +424,11 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAccessApproval_ApprovalRequest. * - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does - * not deny access to the resource if another request has been made and - * approved. It is equivalent in effect to ignoring the request altogether. - * Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION - * if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a + * request is dismissed, it is considered ignored. Dismissing a request does + * not prevent access granted by other Access Approval requests. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the + * request exists but is not in a pending state. * * @param object The @c GTLRAccessApproval_DismissApprovalRequestMessage to * include in the query. @@ -473,10 +473,10 @@ NS_ASSUME_NONNULL_BEGIN /** * Invalidates an existing ApprovalRequest. Returns the updated - * ApprovalRequest. NOTE: This does not deny access to the resource if another - * request has been made and approved. It only invalidates a single approval. - * Returns FAILED_PRECONDITION if the request exists but is not in an approved - * state. + * ApprovalRequest. NOTE: This action revokes Google access based on this + * approval request. If the resource has other active approvals, access will + * remain granted. Returns FAILED_PRECONDITION if the request exists but is not + * in an approved state. * * Method: accessapproval.organizations.approvalRequests.invalidate * @@ -492,10 +492,10 @@ NS_ASSUME_NONNULL_BEGIN * Fetches a @c GTLRAccessApproval_ApprovalRequest. * * Invalidates an existing ApprovalRequest. Returns the updated - * ApprovalRequest. NOTE: This does not deny access to the resource if another - * request has been made and approved. It only invalidates a single approval. - * Returns FAILED_PRECONDITION if the request exists but is not in an approved - * state. + * ApprovalRequest. NOTE: This action revokes Google access based on this + * approval request. If the resource has other active approvals, access will + * remain granted. Returns FAILED_PRECONDITION if the request exists but is not + * in an approved state. * * @param object The @c GTLRAccessApproval_InvalidateApprovalRequestMessage to * include in the query. @@ -565,11 +565,10 @@ NS_ASSUME_NONNULL_BEGIN /** * Deletes the settings associated with a project, folder, or organization. - * This will have the effect of disabling Access Approval for the project, - * folder, or organization, but only if all ancestors also have Access Approval - * disabled. If Access Approval is enabled at a higher level of the hierarchy, - * then Access Approval will still be enabled at this level as the settings are - * inherited. + * This will have the effect of disabling Access Approval for the resource. + * Access Approval may remain active based on parent resource settings. To + * confirm the effective settings, call GetAccessApprovalSettings and verify + * effective setting is disabled. * * Method: accessapproval.organizations.deleteAccessApprovalSettings * @@ -585,11 +584,10 @@ NS_ASSUME_NONNULL_BEGIN * Fetches a @c GTLRAccessApproval_Empty. * * Deletes the settings associated with a project, folder, or organization. - * This will have the effect of disabling Access Approval for the project, - * folder, or organization, but only if all ancestors also have Access Approval - * disabled. If Access Approval is enabled at a higher level of the hierarchy, - * then Access Approval will still be enabled at this level as the settings are - * inherited. + * This will have the effect of disabling Access Approval for the resource. + * Access Approval may remain active based on parent resource settings. To + * confirm the effective settings, call GetAccessApprovalSettings and verify + * effective setting is disabled. * * @param name Name of the AccessApprovalSettings to delete. * @@ -600,7 +598,8 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or + * organization. * * Method: accessapproval.organizations.getAccessApprovalSettings * @@ -618,7 +617,8 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAccessApproval_Settings. * - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or + * organization. * * @param name The name of the AccessApprovalSettings to retrieve. Format: * "{projects|folders|organizations}/{id}/accessApprovalSettings" @@ -743,11 +743,11 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does - * not deny access to the resource if another request has been made and - * approved. It is equivalent in effect to ignoring the request altogether. - * Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION - * if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a + * request is dismissed, it is considered ignored. Dismissing a request does + * not prevent access granted by other Access Approval requests. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the + * request exists but is not in a pending state. * * Method: accessapproval.projects.approvalRequests.dismiss * @@ -762,11 +762,11 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAccessApproval_ApprovalRequest. * - * Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does - * not deny access to the resource if another request has been made and - * approved. It is equivalent in effect to ignoring the request altogether. - * Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION - * if the request exists but is not in a pending state. + * Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a + * request is dismissed, it is considered ignored. Dismissing a request does + * not prevent access granted by other Access Approval requests. Returns + * NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the + * request exists but is not in a pending state. * * @param object The @c GTLRAccessApproval_DismissApprovalRequestMessage to * include in the query. @@ -811,10 +811,10 @@ NS_ASSUME_NONNULL_BEGIN /** * Invalidates an existing ApprovalRequest. Returns the updated - * ApprovalRequest. NOTE: This does not deny access to the resource if another - * request has been made and approved. It only invalidates a single approval. - * Returns FAILED_PRECONDITION if the request exists but is not in an approved - * state. + * ApprovalRequest. NOTE: This action revokes Google access based on this + * approval request. If the resource has other active approvals, access will + * remain granted. Returns FAILED_PRECONDITION if the request exists but is not + * in an approved state. * * Method: accessapproval.projects.approvalRequests.invalidate * @@ -830,10 +830,10 @@ NS_ASSUME_NONNULL_BEGIN * Fetches a @c GTLRAccessApproval_ApprovalRequest. * * Invalidates an existing ApprovalRequest. Returns the updated - * ApprovalRequest. NOTE: This does not deny access to the resource if another - * request has been made and approved. It only invalidates a single approval. - * Returns FAILED_PRECONDITION if the request exists but is not in an approved - * state. + * ApprovalRequest. NOTE: This action revokes Google access based on this + * approval request. If the resource has other active approvals, access will + * remain granted. Returns FAILED_PRECONDITION if the request exists but is not + * in an approved state. * * @param object The @c GTLRAccessApproval_InvalidateApprovalRequestMessage to * include in the query. @@ -903,11 +903,10 @@ NS_ASSUME_NONNULL_BEGIN /** * Deletes the settings associated with a project, folder, or organization. - * This will have the effect of disabling Access Approval for the project, - * folder, or organization, but only if all ancestors also have Access Approval - * disabled. If Access Approval is enabled at a higher level of the hierarchy, - * then Access Approval will still be enabled at this level as the settings are - * inherited. + * This will have the effect of disabling Access Approval for the resource. + * Access Approval may remain active based on parent resource settings. To + * confirm the effective settings, call GetAccessApprovalSettings and verify + * effective setting is disabled. * * Method: accessapproval.projects.deleteAccessApprovalSettings * @@ -923,11 +922,10 @@ NS_ASSUME_NONNULL_BEGIN * Fetches a @c GTLRAccessApproval_Empty. * * Deletes the settings associated with a project, folder, or organization. - * This will have the effect of disabling Access Approval for the project, - * folder, or organization, but only if all ancestors also have Access Approval - * disabled. If Access Approval is enabled at a higher level of the hierarchy, - * then Access Approval will still be enabled at this level as the settings are - * inherited. + * This will have the effect of disabling Access Approval for the resource. + * Access Approval may remain active based on parent resource settings. To + * confirm the effective settings, call GetAccessApprovalSettings and verify + * effective setting is disabled. * * @param name Name of the AccessApprovalSettings to delete. * @@ -938,7 +936,8 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or + * organization. * * Method: accessapproval.projects.getAccessApprovalSettings * @@ -956,7 +955,8 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLRAccessApproval_Settings. * - * Gets the settings associated with a project, folder, or organization. + * Gets the Access Approval settings associated with a project, folder, or + * organization. * * @param name The name of the AccessApprovalSettings to retrieve. Format: * "{projects|folders|organizations}/{id}/accessApprovalSettings" diff --git a/Sources/GeneratedServices/Adsense/GTLRAdsenseQuery.m b/Sources/GeneratedServices/Adsense/GTLRAdsenseQuery.m index 9e8f48f7a..46b202d92 100644 --- a/Sources/GeneratedServices/Adsense/GTLRAdsenseQuery.m +++ b/Sources/GeneratedServices/Adsense/GTLRAdsenseQuery.m @@ -70,6 +70,8 @@ NSString * const kGTLRAdsenseDimensionsServedAdTypeName = @"SERVED_AD_TYPE_NAME"; NSString * const kGTLRAdsenseDimensionsTargetingTypeCode = @"TARGETING_TYPE_CODE"; NSString * const kGTLRAdsenseDimensionsTargetingTypeName = @"TARGETING_TYPE_NAME"; +NSString * const kGTLRAdsenseDimensionsTrafficSourceCode = @"TRAFFIC_SOURCE_CODE"; +NSString * const kGTLRAdsenseDimensionsTrafficSourceName = @"TRAFFIC_SOURCE_NAME"; NSString * const kGTLRAdsenseDimensionsUrlChannelId = @"URL_CHANNEL_ID"; NSString * const kGTLRAdsenseDimensionsUrlChannelName = @"URL_CHANNEL_NAME"; NSString * const kGTLRAdsenseDimensionsWebsearchQueryString = @"WEBSEARCH_QUERY_STRING"; diff --git a/Sources/GeneratedServices/Adsense/Public/GoogleAPIClientForREST/GTLRAdsenseQuery.h b/Sources/GeneratedServices/Adsense/Public/GoogleAPIClientForREST/GTLRAdsenseQuery.h index 423351afd..a603d5958 100644 --- a/Sources/GeneratedServices/Adsense/Public/GoogleAPIClientForREST/GTLRAdsenseQuery.h +++ b/Sources/GeneratedServices/Adsense/Public/GoogleAPIClientForREST/GTLRAdsenseQuery.h @@ -381,6 +381,22 @@ FOUNDATION_EXTERN NSString * const kGTLRAdsenseDimensionsTargetingTypeCode; * Value: "TARGETING_TYPE_NAME" */ FOUNDATION_EXTERN NSString * const kGTLRAdsenseDimensionsTargetingTypeName; +/** + * Traffic source code (e.g. "GOOGLE", "BING", "FACEBOOK", "OTHER"). For more + * information, see [Traffic source + * breakdown](https://support.google.com/adsense/answer/16474600). + * + * Value: "TRAFFIC_SOURCE_CODE" + */ +FOUNDATION_EXTERN NSString * const kGTLRAdsenseDimensionsTrafficSourceCode; +/** + * Localized traffic source name (e.g. "Google", "Bing", "Facebook", "Other"). + * For more information, see [Traffic source + * breakdown](https://support.google.com/adsense/answer/16474600). + * + * Value: "TRAFFIC_SOURCE_NAME" + */ +FOUNDATION_EXTERN NSString * const kGTLRAdsenseDimensionsTrafficSourceName; /** * Unique ID of a URL channel. The members of this dimension match the values * from UrlChannel.reporting_dimension_id. @@ -1886,6 +1902,16 @@ FOUNDATION_EXTERN NSString * const kGTLRAdsenseReportingTimeZoneReportingTimeZon * @arg @c kGTLRAdsenseDimensionsTargetingTypeCode Targeting type code (e.g. * "Keyword", "UserInterest", "RunOfNetwork"). (Value: * "TARGETING_TYPE_CODE") + * @arg @c kGTLRAdsenseDimensionsTrafficSourceName Localized traffic source + * name (e.g. "Google", "Bing", "Facebook", "Other"). For more + * information, see [Traffic source + * breakdown](https://support.google.com/adsense/answer/16474600). + * (Value: "TRAFFIC_SOURCE_NAME") + * @arg @c kGTLRAdsenseDimensionsTrafficSourceCode Traffic source code (e.g. + * "GOOGLE", "BING", "FACEBOOK", "OTHER"). For more information, see + * [Traffic source + * breakdown](https://support.google.com/adsense/answer/16474600). + * (Value: "TRAFFIC_SOURCE_CODE") * @arg @c kGTLRAdsenseDimensionsContentPlatformName Localized content * platform name an ad request was made from (e.g. "AMP", "Web"). (Value: * "CONTENT_PLATFORM_NAME") @@ -2318,6 +2344,16 @@ FOUNDATION_EXTERN NSString * const kGTLRAdsenseReportingTimeZoneReportingTimeZon * @arg @c kGTLRAdsenseDimensionsTargetingTypeCode Targeting type code (e.g. * "Keyword", "UserInterest", "RunOfNetwork"). (Value: * "TARGETING_TYPE_CODE") + * @arg @c kGTLRAdsenseDimensionsTrafficSourceName Localized traffic source + * name (e.g. "Google", "Bing", "Facebook", "Other"). For more + * information, see [Traffic source + * breakdown](https://support.google.com/adsense/answer/16474600). + * (Value: "TRAFFIC_SOURCE_NAME") + * @arg @c kGTLRAdsenseDimensionsTrafficSourceCode Traffic source code (e.g. + * "GOOGLE", "BING", "FACEBOOK", "OTHER"). For more information, see + * [Traffic source + * breakdown](https://support.google.com/adsense/answer/16474600). + * (Value: "TRAFFIC_SOURCE_CODE") * @arg @c kGTLRAdsenseDimensionsContentPlatformName Localized content * platform name an ad request was made from (e.g. "AMP", "Web"). (Value: * "CONTENT_PLATFORM_NAME") diff --git a/Sources/GeneratedServices/Aiplatform/GTLRAiplatformObjects.m b/Sources/GeneratedServices/Aiplatform/GTLRAiplatformObjects.m index b8f4583ba..6e85a4aa8 100644 --- a/Sources/GeneratedServices/Aiplatform/GTLRAiplatformObjects.m +++ b/Sources/GeneratedServices/Aiplatform/GTLRAiplatformObjects.m @@ -200,12 +200,6 @@ NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRun_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRun_State_Succeeded = @"SUCCEEDED"; -// GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec.type -NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_Bleu = @"BLEU"; -NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_ComputationBasedMetricTypeUnspecified = @"COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED"; -NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_ExactMatch = @"EXACT_MATCH"; -NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_Rouge = @"ROUGE"; - // GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec.rubricContentType NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec_RubricContentType_NlQuestionAnswer = @"NL_QUESTION_ANSWER"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec_RubricContentType_Property = @"PROPERTY"; @@ -430,6 +424,7 @@ NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaH100Mega80gb = @"NVIDIA_H100_MEGA_80GB"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaH200141gb = @"NVIDIA_H200_141GB"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaL4 = @"NVIDIA_L4"; +NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaRtxPro6000 = @"NVIDIA_RTX_PRO_6000"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaTeslaA100 = @"NVIDIA_TESLA_A100"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaTeslaK80 = @"NVIDIA_TESLA_K80"; NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaTeslaP100 = @"NVIDIA_TESLA_P100"; @@ -1690,7 +1685,7 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1AutomaticResources // @implementation GTLRAiplatform_GoogleCloudAiplatformV1AutoraterConfig -@dynamic autoraterModel, flipEnabled, samplingCount; +@dynamic autoraterModel, flipEnabled, generationConfig, samplingCount; @end @@ -3913,7 +3908,7 @@ + (Class)classForAdditionalProperties { @implementation GTLRAiplatform_GoogleCloudAiplatformV1DeployRequestEndpointConfig @dynamic dedicatedEndpointDisabled, dedicatedEndpointEnabled, - endpointDisplayName, endpointUserId; + endpointDisplayName, endpointUserId, privateServiceConnectConfig; @end @@ -4675,32 +4670,8 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunInferenceConf // @implementation GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetric -@dynamic computationBasedMetricSpec, llmBasedMetricSpec, metric, - predefinedMetricSpec, rubricBasedMetricSpec; -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec -// - -@implementation GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec -@dynamic parameters, type; -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Parameters -// - -@implementation GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Parameters - -+ (Class)classForAdditionalProperties { - return [NSObject class]; -} - +@dynamic llmBasedMetricSpec, metric, predefinedMetricSpec, + rubricBasedMetricSpec; @end @@ -6912,6 +6883,7 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1GoogleDriveSourceResourceI // @implementation GTLRAiplatform_GoogleCloudAiplatformV1GoogleMaps +@dynamic enableWidget; @end @@ -6991,7 +6963,7 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMaps // @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources -@dynamic flagContentUri, reviewSnippets; +@dynamic reviewSnippets; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -7003,24 +6975,13 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAns @end -// ---------------------------------------------------------------------------- -// -// GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution -// - -@implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution -@dynamic displayName, photoUri, uri; -@end - - // ---------------------------------------------------------------------------- // // GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet // @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet -@dynamic authorAttribution, flagContentUri, googleMapsUri, - relativePublishTimeDescription, review; +@dynamic googleMapsUri, reviewId, title; @end @@ -7051,12 +7012,14 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkWeb @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadata @dynamic googleMapsWidgetContextToken, groundingChunks, groundingSupports, - retrievalMetadata, searchEntryPoint, webSearchQueries; + retrievalMetadata, searchEntryPoint, sourceFlaggingUris, + webSearchQueries; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @"groundingChunks" : [GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunk class], @"groundingSupports" : [GTLRAiplatform_GoogleCloudAiplatformV1GroundingSupport class], + @"sourceFlaggingUris" : [GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri class], @"webSearchQueries" : [NSString class] }; return map; @@ -7065,6 +7028,16 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadata @end +// ---------------------------------------------------------------------------- +// +// GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri +// + +@implementation GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri +@dynamic flagContentUri, sourceId; +@end + + // ---------------------------------------------------------------------------- // // GTLRAiplatform_GoogleCloudAiplatformV1GroundingSupport @@ -7568,6 +7541,16 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1IntegratedGradientsAttribu @end +// ---------------------------------------------------------------------------- +// +// GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest +// + +@implementation GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest +@dynamic deployedModelId, httpBody; +@end + + // ---------------------------------------------------------------------------- // // GTLRAiplatform_GoogleCloudAiplatformV1JiraSource @@ -8872,6 +8855,32 @@ + (NSString *)collectionItemsKey { @end +// ---------------------------------------------------------------------------- +// +// GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec +// + +@implementation GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec +@dynamic additionalConfig, judgeAutoraterConfig, metricPromptTemplate, + predefinedRubricGenerationSpec, rubricGenerationSpec, rubricGroupKey, + systemInstruction; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec_AdditionalConfig +// + +@implementation GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec_AdditionalConfig + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRAiplatform_GoogleCloudAiplatformV1LogprobsResult @@ -8929,6 +8938,16 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1LookupStudyRequest @end +// ---------------------------------------------------------------------------- +// +// GTLRAiplatform_GoogleCloudAiplatformV1LustreMount +// + +@implementation GTLRAiplatform_GoogleCloudAiplatformV1LustreMount +@dynamic filesystem, instanceIp, mountPoint, volumeHandle; +@end + + // ---------------------------------------------------------------------------- // // GTLRAiplatform_GoogleCloudAiplatformV1MachineSpec @@ -9054,8 +9073,9 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1MetadataStoreMetadataStore // @implementation GTLRAiplatform_GoogleCloudAiplatformV1Metric -@dynamic aggregationMetrics, bleuSpec, exactMatchSpec, pairwiseMetricSpec, - pointwiseMetricSpec, predefinedMetricSpec, rougeSpec; +@dynamic aggregationMetrics, bleuSpec, exactMatchSpec, llmBasedMetricSpec, + pairwiseMetricSpec, pointwiseMetricSpec, predefinedMetricSpec, + rougeSpec; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -18348,11 +18368,12 @@ @implementation GTLRAiplatform_GoogleCloudAiplatformV1VoiceConfig // @implementation GTLRAiplatform_GoogleCloudAiplatformV1WorkerPoolSpec -@dynamic containerSpec, diskSpec, machineSpec, nfsMounts, pythonPackageSpec, - replicaCount; +@dynamic containerSpec, diskSpec, lustreMounts, machineSpec, nfsMounts, + pythonPackageSpec, replicaCount; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"lustreMounts" : [GTLRAiplatform_GoogleCloudAiplatformV1LustreMount class], @"nfsMounts" : [GTLRAiplatform_GoogleCloudAiplatformV1NfsMount class] }; return map; diff --git a/Sources/GeneratedServices/Aiplatform/GTLRAiplatformQuery.m b/Sources/GeneratedServices/Aiplatform/GTLRAiplatformQuery.m index 3b118104c..83acca737 100644 --- a/Sources/GeneratedServices/Aiplatform/GTLRAiplatformQuery.m +++ b/Sources/GeneratedServices/Aiplatform/GTLRAiplatformQuery.m @@ -2562,6 +2562,39 @@ + (instancetype)queryWithName:(NSString *)name { @end +@implementation GTLRAiplatformQuery_ProjectsLocationsEndpointsDeployedModelsInvokeInvoke + +@dynamic deployedModelId, endpoint, invokeId; + ++ (instancetype)queryWithObject:(GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest *)object + endpoint:(NSString *)endpoint + deployedModelId:(NSString *)deployedModelId + invokeId:(NSString *)invokeId { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ + @"deployedModelId", @"endpoint", @"invokeId" + ]; + NSString *pathURITemplate = @"v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}"; + GTLRAiplatformQuery_ProjectsLocationsEndpointsDeployedModelsInvokeInvoke *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.endpoint = endpoint; + query.deployedModelId = deployedModelId; + query.invokeId = invokeId; + query.expectedObjectClass = [GTLRAiplatform_GoogleApiHttpBody class]; + query.loggingName = @"aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke"; + return query; +} + +@end + @implementation GTLRAiplatformQuery_ProjectsLocationsEndpointsDeployModel @dynamic endpoint; @@ -2743,6 +2776,37 @@ + (instancetype)queryWithName:(NSString *)name { @end +@implementation GTLRAiplatformQuery_ProjectsLocationsEndpointsInvokeInvoke + +@dynamic endpoint, invokeId; + ++ (instancetype)queryWithObject:(GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest *)object + endpoint:(NSString *)endpoint + invokeId:(NSString *)invokeId { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ + @"endpoint", @"invokeId" + ]; + NSString *pathURITemplate = @"v1/{+endpoint}/invoke/{+invokeId}"; + GTLRAiplatformQuery_ProjectsLocationsEndpointsInvokeInvoke *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.endpoint = endpoint; + query.invokeId = invokeId; + query.expectedObjectClass = [GTLRAiplatform_GoogleApiHttpBody class]; + query.loggingName = @"aiplatform.projects.locations.endpoints.invoke.invoke"; + return query; +} + +@end + @implementation GTLRAiplatformQuery_ProjectsLocationsEndpointsList @dynamic filter, gdcZone, orderBy, pageSize, pageToken, parent, readMask; @@ -2789,6 +2853,33 @@ + (instancetype)queryWithObject:(GTLRAiplatform_GoogleCloudAiplatformV1MutateDep @end +@implementation GTLRAiplatformQuery_ProjectsLocationsEndpointsOpenapiEmbeddings + +@dynamic deployedModelId, endpoint; + ++ (instancetype)queryWithObject:(GTLRAiplatform_GoogleApiHttpBody *)object + endpoint:(NSString *)endpoint { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"endpoint" ]; + NSString *pathURITemplate = @"v1/{+endpoint}/embeddings"; + GTLRAiplatformQuery_ProjectsLocationsEndpointsOpenapiEmbeddings *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.endpoint = endpoint; + query.expectedObjectClass = [GTLRAiplatform_GoogleApiHttpBody class]; + query.loggingName = @"aiplatform.projects.locations.endpoints.openapi.embeddings"; + return query; +} + +@end + @implementation GTLRAiplatformQuery_ProjectsLocationsEndpointsOperationsCancel @dynamic name; diff --git a/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformObjects.h b/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformObjects.h index e64e824e2..480df4980 100644 --- a/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformObjects.h +++ b/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformObjects.h @@ -191,8 +191,6 @@ @class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate; @class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunInferenceConfig; @class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetric; -@class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec; -@class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Parameters; @class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec; @class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec_AdditionalConfig; @class GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec; @@ -342,11 +340,11 @@ @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunk; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMaps; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources; -@class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkRetrievedContext; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkWeb; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadata; +@class GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri; @class GTLRAiplatform_GoogleCloudAiplatformV1GroundingSupport; @class GTLRAiplatform_GoogleCloudAiplatformV1HyperparameterTuningJob; @class GTLRAiplatform_GoogleCloudAiplatformV1HyperparameterTuningJob_Labels; @@ -374,9 +372,12 @@ @class GTLRAiplatform_GoogleCloudAiplatformV1JiraSource; @class GTLRAiplatform_GoogleCloudAiplatformV1JiraSourceJiraQueries; @class GTLRAiplatform_GoogleCloudAiplatformV1LargeModelReference; +@class GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec; +@class GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec_AdditionalConfig; @class GTLRAiplatform_GoogleCloudAiplatformV1LogprobsResult; @class GTLRAiplatform_GoogleCloudAiplatformV1LogprobsResultCandidate; @class GTLRAiplatform_GoogleCloudAiplatformV1LogprobsResultTopCandidates; +@class GTLRAiplatform_GoogleCloudAiplatformV1LustreMount; @class GTLRAiplatform_GoogleCloudAiplatformV1MachineSpec; @class GTLRAiplatform_GoogleCloudAiplatformV1ManualBatchTuningParameters; @class GTLRAiplatform_GoogleCloudAiplatformV1Measurement; @@ -1947,34 +1948,6 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1Evalua */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRun_State_Succeeded; -// ---------------------------------------------------------------------------- -// GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec.type - -/** - * BLEU metric. - * - * Value: "BLEU" - */ -FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_Bleu; -/** - * Unspecified computation based metric type. - * - * Value: "COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_ComputationBasedMetricTypeUnspecified; -/** - * Exact match metric. - * - * Value: "EXACT_MATCH" - */ -FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_ExactMatch; -/** - * ROUGE metric. - * - * Value: "ROUGE" - */ -FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_Rouge; - // ---------------------------------------------------------------------------- // GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec.rubricContentType @@ -2748,44 +2721,46 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1Functi // GTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback.blockReason /** - * Unspecified blocked reason. + * The blocked reason is unspecified. * * Value: "BLOCKED_REASON_UNSPECIFIED" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_BlockedReasonUnspecified; /** - * Candidates blocked due to the terms which are included from the terminology + * The prompt was blocked because it contains a term from the terminology * blocklist. * * Value: "BLOCKLIST" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_Blocklist; /** - * Candidates blocked due to unsafe image generation content. + * The prompt was blocked because it contains content that is unsafe for image + * generation. * * Value: "IMAGE_SAFETY" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_ImageSafety; /** - * The user prompt was blocked by Model Armor. + * The prompt was blocked by Model Armor. * * Value: "MODEL_ARMOR" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_ModelArmor; /** - * Candidates blocked due to other reason. + * The prompt was blocked for other reasons. For example, it may be due to the + * prompt's language, or because it contains other harmful content. * * Value: "OTHER" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_Other; /** - * Candidates blocked due to prohibited content. + * The prompt was blocked because it contains prohibited content. * * Value: "PROHIBITED_CONTENT" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_ProhibitedContent; /** - * Candidates blocked due to safety. + * The prompt was blocked for safety reasons. * * Value: "SAFETY" */ @@ -2795,7 +2770,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1Genera // GTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.trafficType /** - * Type for Pay-As-You-Go traffic. + * The request was processed using Pay-As-You-Go quota. * * Value: "ON_DEMAND" */ @@ -3119,6 +3094,12 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1Machin * Value: "NVIDIA_L4" */ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaL4; +/** + * Nvidia RTX Pro 6000 GPU. + * + * Value: "NVIDIA_RTX_PRO_6000" + */ +FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaRtxPro6000; /** * Nvidia Tesla A100 GPU. * @@ -7810,6 +7791,9 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet */ @property(nonatomic, strong, nullable) NSNumber *flipEnabled; +/** Optional. Configuration options for model generation and outputs. */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1GenerationConfig *generationConfig; + /** * Optional. Number of samples for each instance in the dataset. If not * specified, the default is 4. Minimum value is 1, maximum value is 32. @@ -8713,8 +8697,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @property(nonatomic, copy, nullable) NSString *promptColumn; /** - * Optional. The name of the column that contains the rubrics. This will be in - * evaluation_rubric.RubricGroup format (cl/762595858). + * Optional. The name of the column that contains the rubrics. This is in + * evaluation_rubric.RubricGroup format. */ @property(nonatomic, copy, nullable) NSString *rubricsColumn; @@ -12428,8 +12412,10 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @interface GTLRAiplatform_GoogleCloudAiplatformV1DeployRequestEndpointConfig : GTLRObject /** - * Optional. By default, if dedicated endpoint is enabled, the endpoint will be - * exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your + * Optional. By default, if dedicated endpoint is enabled and private service + * connect config is not set, the endpoint will be exposed through a dedicated + * DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is + * set, the endpoint will be exposed through private service connect. Your * request to the dedicated DNS will be isolated from other users' traffic and * will have better performance and reliability. Note: Once you enabled * dedicated endpoint, you won't be able to send request to the shared DNS @@ -12474,6 +12460,12 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet */ @property(nonatomic, copy, nullable) NSString *endpointUserId; +/** + * Optional. Configuration for private service connect. If set, the endpoint + * will be exposed through private service connect. + */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1PrivateServiceConnectConfig *privateServiceConnectConfig; + @end @@ -13703,7 +13695,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet /** Output only. The response from evaluation. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1EvaluationResult *evaluationResponse; -/** The GCS object where the request or response is stored. */ +/** The Cloud Storage object where the request or response is stored. */ @property(nonatomic, copy, nullable) NSString *gcsUri; /** Optional. Labels for the EvaluationItem. */ @@ -14155,9 +14147,6 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet */ @interface GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetric : GTLRObject -/** Spec for a computation based metric. */ -@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec *computationBasedMetricSpec; - /** Spec for an LLM based metric. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec *llmBasedMetricSpec; @@ -14173,47 +14162,6 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @end -/** - * Specification for a computation based metric. - */ -@interface GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec : GTLRObject - -/** - * Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - */ -@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Parameters *parameters; - -/** - * Required. The type of the computation based metric. - * - * Likely values: - * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_Bleu - * BLEU metric. (Value: "BLEU") - * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_ComputationBasedMetricTypeUnspecified - * Unspecified computation based metric type. (Value: - * "COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED") - * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_ExactMatch - * Exact match metric. (Value: "EXACT_MATCH") - * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Type_Rouge - * ROUGE metric. (Value: "ROUGE") - */ -@property(nonatomic, copy, nullable) NSString *type; - -@end - - -/** - * Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. - */ -@interface GTLRAiplatform_GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec_Parameters : GTLRObject -@end - - /** * Specification for an LLM based metric. */ @@ -18246,7 +18194,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1FunctionCall_Args *args; /** - * Required. The name of the function to call. Matches + * Optional. The name of the function to call. Matches * [FunctionDeclaration.name]. */ @property(nonatomic, copy, nullable) NSString *name; @@ -18606,120 +18554,141 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet /** - * Content filter results for a prompt sent in the request. + * Content filter results for a prompt sent in the request. Note: This is sent + * only in the first stream chunk and only if no candidates were generated due + * to content violations. */ @interface GTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback : GTLRObject /** - * Output only. Blocked reason. + * Output only. The reason why the prompt was blocked. * * Likely values: * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_BlockedReasonUnspecified - * Unspecified blocked reason. (Value: "BLOCKED_REASON_UNSPECIFIED") + * The blocked reason is unspecified. (Value: + * "BLOCKED_REASON_UNSPECIFIED") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_Blocklist - * Candidates blocked due to the terms which are included from the - * terminology blocklist. (Value: "BLOCKLIST") + * The prompt was blocked because it contains a term from the terminology + * blocklist. (Value: "BLOCKLIST") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_ImageSafety - * Candidates blocked due to unsafe image generation content. (Value: - * "IMAGE_SAFETY") + * The prompt was blocked because it contains content that is unsafe for + * image generation. (Value: "IMAGE_SAFETY") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_ModelArmor - * The user prompt was blocked by Model Armor. (Value: "MODEL_ARMOR") + * The prompt was blocked by Model Armor. (Value: "MODEL_ARMOR") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_Other - * Candidates blocked due to other reason. (Value: "OTHER") + * The prompt was blocked for other reasons. For example, it may be due + * to the prompt's language, or because it contains other harmful + * content. (Value: "OTHER") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_ProhibitedContent - * Candidates blocked due to prohibited content. (Value: + * The prompt was blocked because it contains prohibited content. (Value: * "PROHIBITED_CONTENT") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback_BlockReason_Safety - * Candidates blocked due to safety. (Value: "SAFETY") + * The prompt was blocked for safety reasons. (Value: "SAFETY") */ @property(nonatomic, copy, nullable) NSString *blockReason; -/** Output only. A readable block reason message. */ +/** + * Output only. A readable message that explains the reason why the prompt was + * blocked. + */ @property(nonatomic, copy, nullable) NSString *blockReasonMessage; -/** Output only. Safety ratings. */ +/** + * Output only. A list of safety ratings for the prompt. There is one rating + * per category. + */ @property(nonatomic, strong, nullable) NSArray *safetyRatings; @end /** - * Usage metadata about response(s). + * Usage metadata about the content generation request and response. This + * message provides a detailed breakdown of token usage and other relevant + * metrics. */ @interface GTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata : GTLRObject /** - * Output only. Number of tokens in the cached part in the input (the cached - * content). + * Output only. The number of tokens in the cached content that was used for + * this request. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *cachedContentTokenCount; /** - * Output only. List of modalities of the cached content in the request input. + * Output only. A detailed breakdown of the token count for each modality in + * the cached content. */ @property(nonatomic, strong, nullable) NSArray *cacheTokensDetails; /** - * Number of tokens in the response(s). + * The total number of tokens in the generated candidates. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *candidatesTokenCount; -/** Output only. List of modalities that were returned in the response. */ +/** + * Output only. A detailed breakdown of the token count for each modality in + * the generated candidates. + */ @property(nonatomic, strong, nullable) NSArray *candidatesTokensDetails; /** - * Number of tokens in the request. When `cached_content` is set, this is still - * the total effective prompt size meaning this includes the number of tokens - * in the cached content. + * The total number of tokens in the prompt. This includes any text, images, or + * other media provided in the request. When `cached_content` is set, this also + * includes the number of tokens in the cached content. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *promptTokenCount; /** - * Output only. List of modalities that were processed in the request input. + * Output only. A detailed breakdown of the token count for each modality in + * the prompt. */ @property(nonatomic, strong, nullable) NSArray *promptTokensDetails; /** - * Output only. Number of tokens present in thoughts output. + * Output only. The number of tokens that were part of the model's generated + * "thoughts" output, if applicable. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *thoughtsTokenCount; /** - * Output only. Number of tokens present in tool-use prompt(s). + * Output only. The number of tokens in the results from tool executions, which + * are provided back to the model as input, if applicable. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *toolUsePromptTokenCount; /** - * Output only. List of modalities that were processed for tool-use request - * inputs. + * Output only. A detailed breakdown by modality of the token counts from the + * results of tool executions, which are provided back to the model as input. */ @property(nonatomic, strong, nullable) NSArray *toolUsePromptTokensDetails; /** - * Total token count for prompt, response candidates, and tool-use prompts (if - * present). + * The total number of tokens for the entire request. This is the sum of + * `prompt_token_count`, `candidates_token_count`, + * `tool_use_prompt_token_count`, and `thoughts_token_count`. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *totalTokenCount; /** - * Output only. Traffic type. This shows whether a request consumes - * Pay-As-You-Go or Provisioned Throughput quota. + * Output only. The traffic type for this request. * * Likely values: * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata_TrafficType_OnDemand - * Type for Pay-As-You-Go traffic. (Value: "ON_DEMAND") + * The request was processed using Pay-As-You-Go quota. (Value: + * "ON_DEMAND") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata_TrafficType_ProvisionedThroughput * Type for Provisioned Throughput traffic. (Value: * "PROVISIONED_THROUGHPUT") @@ -19173,6 +19142,14 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet * Tool to retrieve public maps data for grounding, powered by Google. */ @interface GTLRAiplatform_GoogleCloudAiplatformV1GoogleMaps : GTLRObject + +/** + * Optional. If true, include the widget context token in the response. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableWidget; + @end @@ -19293,13 +19270,13 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet */ @property(nonatomic, copy, nullable) NSString *placeId; -/** Text of the chunk. */ +/** Text of the place answer. */ @property(nonatomic, copy, nullable) NSString *text; -/** Title of the chunk. */ +/** Title of the place. */ @property(nonatomic, copy, nullable) NSString *title; -/** URI reference of the chunk. */ +/** URI reference of the place. */ @property(nonatomic, copy, nullable) NSString *uri; @end @@ -19310,57 +19287,25 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet */ @interface GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources : GTLRObject -/** A link where users can flag a problem with the generated answer. */ -@property(nonatomic, copy, nullable) NSString *flagContentUri; - /** Snippets of reviews that are used to generate the answer. */ @property(nonatomic, strong, nullable) NSArray *reviewSnippets; @end -/** - * Author attribution for a photo or review. - */ -@interface GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution : GTLRObject - -/** Name of the author of the Photo or Review. */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Profile photo URI of the author of the Photo or Review. */ -@property(nonatomic, copy, nullable) NSString *photoUri; - -/** URI of the author of the Photo or Review. */ -@property(nonatomic, copy, nullable) NSString *uri; - -@end - - /** * Encapsulates a review snippet. */ @interface GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet : GTLRObject -/** This review's author. */ -@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution *authorAttribution; - -/** A link where users can flag a problem with the review. */ -@property(nonatomic, copy, nullable) NSString *flagContentUri; - /** A link to show the review on Google Maps. */ @property(nonatomic, copy, nullable) NSString *googleMapsUri; -/** - * A string of formatted recent time, expressing the review time relative to - * the current time in a form appropriate for the language and country. - */ -@property(nonatomic, copy, nullable) NSString *relativePublishTimeDescription; +/** Id of the review referencing the place. */ +@property(nonatomic, copy, nullable) NSString *reviewId; -/** - * A reference representing this place review which may be used to look up this - * place review again. - */ -@property(nonatomic, copy, nullable) NSString *review; +/** Title of the review. */ +@property(nonatomic, copy, nullable) NSString *title; @end @@ -19437,12 +19382,35 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet /** Optional. Google search entry for the following-up web searches. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1SearchEntryPoint *searchEntryPoint; +/** + * Optional. Output only. List of source flagging uris. This is currently + * populated only for Google Maps grounding. + */ +@property(nonatomic, strong, nullable) NSArray *sourceFlaggingUris; + /** Optional. Web search queries for the following-up web search. */ @property(nonatomic, strong, nullable) NSArray *webSearchQueries; @end +/** + * Source content flagging uri for a place or review. This is currently + * populated only for Google Maps grounding. + */ +@interface GTLRAiplatform_GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri : GTLRObject + +/** + * A link where users can flag a problem with the source (place or review). + */ +@property(nonatomic, copy, nullable) NSString *flagContentUri; + +/** Id of the place or review. */ +@property(nonatomic, copy, nullable) NSString *sourceId; + +@end + + /** * Grounding support. */ @@ -20745,6 +20713,22 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @end +/** + * Request message for PredictionService.Invoke. + */ +@interface GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest : GTLRObject + +/** ID of the DeployedModel that serves the invoke request. */ +@property(nonatomic, copy, nullable) NSString *deployedModelId; + +/** + * The invoke method input. Supports HTTP headers and arbitrary data payload. + */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleApiHttpBody *httpBody; + +@end + + /** * The Jira source for the ImportRagFilesRequest. */ @@ -22311,6 +22295,50 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @end +/** + * Specification for an LLM based metric. + */ +@interface GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec : GTLRObject + +/** Optional. Optional additional configuration for the metric. */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec_AdditionalConfig *additionalConfig; + +/** Optional. Optional configuration for the judge LLM (Autorater). */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1AutoraterConfig *judgeAutoraterConfig; + +/** Required. Template for the prompt sent to the judge model. */ +@property(nonatomic, copy, nullable) NSString *metricPromptTemplate; + +/** Dynamically generate rubrics using a predefined spec. */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1PredefinedMetricSpec *predefinedRubricGenerationSpec; + +/** Dynamically generate rubrics using this specification. */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1RubricGenerationSpec *rubricGenerationSpec; + +/** + * Use a pre-defined group of rubrics associated with the input. Refers to a + * key in the rubric_groups map of EvaluationInstance. + */ +@property(nonatomic, copy, nullable) NSString *rubricGroupKey; + +/** Optional. System instructions for the judge model. */ +@property(nonatomic, copy, nullable) NSString *systemInstruction; + +@end + + +/** + * Optional. Optional additional configuration for the metric. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec_AdditionalConfig : GTLRObject +@end + + /** * Logprobs Result */ @@ -22375,6 +22403,29 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet @end +/** + * Represents a mount configuration for Lustre file system. + */ +@interface GTLRAiplatform_GoogleCloudAiplatformV1LustreMount : GTLRObject + +/** Required. The name of the Lustre filesystem. */ +@property(nonatomic, copy, nullable) NSString *filesystem; + +/** Required. IP address of the Lustre instance. */ +@property(nonatomic, copy, nullable) NSString *instanceIp; + +/** + * Required. Destination mount path. The Lustre file system will be mounted for + * the user under /mnt/lustre/ + */ +@property(nonatomic, copy, nullable) NSString *mountPoint; + +/** Required. The unique identifier of the Lustre volume. */ +@property(nonatomic, copy, nullable) NSString *volumeHandle; + +@end + + /** * Specification of a single machine. */ @@ -22409,6 +22460,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet * Nvidia H200 141Gb GPU. (Value: "NVIDIA_H200_141GB") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaL4 * Nvidia L4 GPU. (Value: "NVIDIA_L4") + * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaRtxPro6000 + * Nvidia RTX Pro 6000 GPU. (Value: "NVIDIA_RTX_PRO_6000") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaTeslaA100 * Nvidia Tesla A100 GPU. (Value: "NVIDIA_TESLA_A100") * @arg @c kGTLRAiplatform_GoogleCloudAiplatformV1MachineSpec_AcceleratorType_NvidiaTeslaK80 @@ -22691,6 +22744,9 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatform_GoogleCloudAiplatformV1UrlMet /** Spec for exact match metric. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1ExactMatchSpec *exactMatchSpec; +/** Spec for an LLM based metric. */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1LLMBasedMetricSpec *llmBasedMetricSpec; + /** Spec for pairwise metric. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1PairwiseMetricSpec *pairwiseMetricSpec; @@ -30521,7 +30577,8 @@ GTLR_DEPRECATED * Optional. User provided package spec of the ReasoningEngine. Ignored when * users directly specify a deployment image through * `deployment_spec.first_party_image_override`, but keeping the field_behavior - * to avoid introducing breaking changes. + * to avoid introducing breaking changes. The `deployment_source` field should + * not be set if `package_spec` is specified. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec *packageSpec; @@ -30630,7 +30687,8 @@ GTLR_DEPRECATED /** - * User provided package spec like pickled object and package requirements. + * User-provided package specification, containing pickled object and package + * requirements. */ @interface GTLRAiplatform_GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec : GTLRObject @@ -40740,11 +40798,8 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1ToolGoogleSearch *googleSearch; -/** - * Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that - * is powered by Google search. - */ -@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1GoogleSearchRetrieval *googleSearchRetrieval; +/** Optional. Specialized retrieval tool that is powered by Google Search. */ +@property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1GoogleSearchRetrieval *googleSearchRetrieval GTLR_DEPRECATED; /** * Optional. Retrieval tool type. System will always execute the provided @@ -42797,6 +42852,9 @@ GTLR_DEPRECATED /** Disk spec. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1DiskSpec *diskSpec; +/** Optional. List of Lustre mounts. */ +@property(nonatomic, strong, nullable) NSArray *lustreMounts; + /** Optional. Immutable. The specification of a single machine. */ @property(nonatomic, strong, nullable) GTLRAiplatform_GoogleCloudAiplatformV1MachineSpec *machineSpec; diff --git a/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformQuery.h b/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformQuery.h index e7438a35a..fe2c18229 100644 --- a/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformQuery.h +++ b/Sources/GeneratedServices/Aiplatform/Public/GoogleAPIClientForREST/GTLRAiplatformQuery.h @@ -4744,6 +4744,55 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif @end +/** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. + * To use this method, invoke_route_prefix must be set to allow the paths that + * will be specified in the request. + * + * Method: aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke + * + * Authorization scope(s): + * @c kGTLRAuthScopeAiplatformCloudPlatform + * @c kGTLRAuthScopeAiplatformCloudPlatformReadOnly + */ +@interface GTLRAiplatformQuery_ProjectsLocationsEndpointsDeployedModelsInvokeInvoke : GTLRAiplatformQuery + +/** ID of the DeployedModel that serves the invoke request. */ +@property(nonatomic, copy, nullable) NSString *deployedModelId; + +/** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ +@property(nonatomic, copy, nullable) NSString *endpoint; + +@property(nonatomic, copy, nullable) NSString *invokeId; + +/** + * Fetches a @c GTLRAiplatform_GoogleApiHttpBody. + * + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. + * To use this method, invoke_route_prefix must be set to allow the paths that + * will be specified in the request. + * + * @param object The @c GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest to + * include in the query. + * @param endpoint Required. The name of the Endpoint requested to serve the + * prediction. Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + * @param deployedModelId ID of the DeployedModel that serves the invoke + * request. + * @param invokeId NSString + * + * @return GTLRAiplatformQuery_ProjectsLocationsEndpointsDeployedModelsInvokeInvoke + */ ++ (instancetype)queryWithObject:(GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest *)object + endpoint:(NSString *)endpoint + deployedModelId:(NSString *)deployedModelId + invokeId:(NSString *)invokeId; + +@end + /** * Deploys a Model into this Endpoint, creating a DeployedModel within it. * @@ -5005,6 +5054,49 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif @end +/** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. + * To use this method, invoke_route_prefix must be set to allow the paths that + * will be specified in the request. + * + * Method: aiplatform.projects.locations.endpoints.invoke.invoke + * + * Authorization scope(s): + * @c kGTLRAuthScopeAiplatformCloudPlatform + * @c kGTLRAuthScopeAiplatformCloudPlatformReadOnly + */ +@interface GTLRAiplatformQuery_ProjectsLocationsEndpointsInvokeInvoke : GTLRAiplatformQuery + +/** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ +@property(nonatomic, copy, nullable) NSString *endpoint; + +@property(nonatomic, copy, nullable) NSString *invokeId; + +/** + * Fetches a @c GTLRAiplatform_GoogleApiHttpBody. + * + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. + * To use this method, invoke_route_prefix must be set to allow the paths that + * will be specified in the request. + * + * @param object The @c GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest to + * include in the query. + * @param endpoint Required. The name of the Endpoint requested to serve the + * prediction. Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + * @param invokeId NSString + * + * @return GTLRAiplatformQuery_ProjectsLocationsEndpointsInvokeInvoke + */ ++ (instancetype)queryWithObject:(GTLRAiplatform_GoogleCloudAiplatformV1InvokeRequest *)object + endpoint:(NSString *)endpoint + invokeId:(NSString *)invokeId; + +@end + /** * Lists Endpoints in a Location. * @@ -5125,6 +5217,48 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif @end +/** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. + * To use this method, invoke_route_prefix must be set to allow the paths that + * will be specified in the request. + * + * Method: aiplatform.projects.locations.endpoints.openapi.embeddings + * + * Authorization scope(s): + * @c kGTLRAuthScopeAiplatformCloudPlatform + * @c kGTLRAuthScopeAiplatformCloudPlatformReadOnly + */ +@interface GTLRAiplatformQuery_ProjectsLocationsEndpointsOpenapiEmbeddings : GTLRAiplatformQuery + +/** ID of the DeployedModel that serves the invoke request. */ +@property(nonatomic, copy, nullable) NSString *deployedModelId; + +/** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ +@property(nonatomic, copy, nullable) NSString *endpoint; + +/** + * Fetches a @c GTLRAiplatform_GoogleApiHttpBody. + * + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. + * To use this method, invoke_route_prefix must be set to allow the paths that + * will be specified in the request. + * + * @param object The @c GTLRAiplatform_GoogleApiHttpBody to include in the + * query. + * @param endpoint Required. The name of the Endpoint requested to serve the + * prediction. Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + * + * @return GTLRAiplatformQuery_ProjectsLocationsEndpointsOpenapiEmbeddings + */ ++ (instancetype)queryWithObject:(GTLRAiplatform_GoogleApiHttpBody *)object + endpoint:(NSString *)endpoint; + +@end + /** * Starts asynchronous cancellation on a long-running operation. The server * makes a best effort to cancel the operation, but success is not guaranteed. @@ -12132,8 +12266,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif @interface GTLRAiplatformQuery_ProjectsLocationsList : GTLRAiplatformQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -12333,7 +12467,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif /** * The maximum number of Artifacts to return. The service may return fewer. - * Must be in range 1-1000, inclusive. Defaults to 100. + * Must be in range 1-100, inclusive. Defaults to 100. */ @property(nonatomic, assign) NSInteger pageSize; @@ -12950,7 +13084,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif /** * The maximum number of Contexts to return. The service may return fewer. Must - * be in range 1-1000, inclusive. Defaults to 100. + * be in range 1-100, inclusive. Defaults to 100. */ @property(nonatomic, assign) NSInteger pageSize; @@ -13611,7 +13745,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif /** * The maximum number of Executions to return. The service may return fewer. - * Must be in range 1-1000, inclusive. Defaults to 100. + * Must be in range 1-100, inclusive. Defaults to 100. */ @property(nonatomic, assign) NSInteger pageSize; @@ -13996,7 +14130,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif /** * The maximum number of Metadata Stores to return. The service may return - * fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * fewer. Must be in range 1-100, inclusive. Defaults to 100. */ @property(nonatomic, assign) NSInteger pageSize; @@ -14125,7 +14259,7 @@ FOUNDATION_EXTERN NSString * const kGTLRAiplatformViewPublisherModelViewUnspecif /** * The maximum number of MetadataSchemas to return. The service may return - * fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * fewer. Must be in range 1-100, inclusive. Defaults to 100. */ @property(nonatomic, assign) NSInteger pageSize; diff --git a/Sources/GeneratedServices/AlertCenter/GTLRAlertCenterObjects.m b/Sources/GeneratedServices/AlertCenter/GTLRAlertCenterObjects.m index ba9609090..d30e83024 100644 --- a/Sources/GeneratedServices/AlertCenter/GTLRAlertCenterObjects.m +++ b/Sources/GeneratedServices/AlertCenter/GTLRAlertCenterObjects.m @@ -36,6 +36,7 @@ NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_Spam = @"SPAM"; NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_TosViolation = @"TOS_VIOLATION"; NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_TrafficPumping = @"TRAFFIC_PUMPING"; +NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_UnqualifiedEdu = @"UNQUALIFIED_EDU"; NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_UnwantedContent = @"UNWANTED_CONTENT"; // GTLRAlertCenter_AccountSuspensionWarning.state diff --git a/Sources/GeneratedServices/AlertCenter/Public/GoogleAPIClientForREST/GTLRAlertCenterObjects.h b/Sources/GeneratedServices/AlertCenter/Public/GoogleAPIClientForREST/GTLRAlertCenterObjects.h index 72ded3434..d32ca8946 100644 --- a/Sources/GeneratedServices/AlertCenter/Public/GoogleAPIClientForREST/GTLRAlertCenterObjects.h +++ b/Sources/GeneratedServices/AlertCenter/Public/GoogleAPIClientForREST/GTLRAlertCenterObjects.h @@ -185,6 +185,13 @@ FOUNDATION_EXTERN NSString * const kGTLRAlertCenter_AccountSuspensionDetails_Abu * Value: "TRAFFIC_PUMPING" */ FOUNDATION_EXTERN NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_TrafficPumping; +/** + * This account is being suspended for being an unqualified educational + * institution. + * + * Value: "UNQUALIFIED_EDU" + */ +FOUNDATION_EXTERN NSString * const kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_UnqualifiedEdu; /** * This account is being suspended for unwanted content. * @@ -984,6 +991,9 @@ FOUNDATION_EXTERN NSString * const kGTLRAlertCenter_VoiceMisconfiguration_Entity * @arg @c kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_TrafficPumping * This account is being suspended for artificially boosting traffic to a * website. (Value: "TRAFFIC_PUMPING") + * @arg @c kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_UnqualifiedEdu + * This account is being suspended for being an unqualified educational + * institution. (Value: "UNQUALIFIED_EDU") * @arg @c kGTLRAlertCenter_AccountSuspensionDetails_AbuseReason_UnwantedContent * This account is being suspended for unwanted content. (Value: * "UNWANTED_CONTENT") diff --git a/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementObjects.m b/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementObjects.m index 32f3597e7..d87b5468d 100644 --- a/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementObjects.m +++ b/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementObjects.m @@ -902,6 +902,13 @@ NSString * const kGTLRAndroidManagement_RequestDeviceInfoStatus_Status_Unsupported = @"UNSUPPORTED"; NSString * const kGTLRAndroidManagement_RequestDeviceInfoStatus_Status_UserDeclined = @"USER_DECLINED"; +// GTLRAndroidManagement_Role.roleType +NSString * const kGTLRAndroidManagement_Role_RoleType_CompanionApp = @"COMPANION_APP"; +NSString * const kGTLRAndroidManagement_Role_RoleType_Kiosk = @"KIOSK"; +NSString * const kGTLRAndroidManagement_Role_RoleType_MobileThreatDefenseEndpointDetectionResponse = @"MOBILE_THREAT_DEFENSE_ENDPOINT_DETECTION_RESPONSE"; +NSString * const kGTLRAndroidManagement_Role_RoleType_RoleTypeUnspecified = @"ROLE_TYPE_UNSPECIFIED"; +NSString * const kGTLRAndroidManagement_Role_RoleType_SystemHealthMonitoring = @"SYSTEM_HEALTH_MONITORING"; + // GTLRAndroidManagement_ScreenBrightnessSettings.screenBrightnessMode NSString * const kGTLRAndroidManagement_ScreenBrightnessSettings_ScreenBrightnessMode_BrightnessAutomatic = @"BRIGHTNESS_AUTOMATIC"; NSString * const kGTLRAndroidManagement_ScreenBrightnessSettings_ScreenBrightnessMode_BrightnessFixed = @"BRIGHTNESS_FIXED"; @@ -1237,8 +1244,8 @@ @implementation GTLRAndroidManagement_ApplicationPolicy defaultPermissionPolicy, delegatedScopes, disabled, extensionConfig, installConstraint, installPriority, installType, lockTaskAllowed, managedConfiguration, managedConfigurationTemplate, minimumVersionCode, - packageName, permissionGrants, preferentialNetworkId, signingKeyCerts, - userControlSettings, workProfileWidgets; + packageName, permissionGrants, preferentialNetworkId, roles, + signingKeyCerts, userControlSettings, workProfileWidgets; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -1246,6 +1253,7 @@ @implementation GTLRAndroidManagement_ApplicationPolicy @"delegatedScopes" : [NSString class], @"installConstraint" : [GTLRAndroidManagement_InstallConstraint class], @"permissionGrants" : [GTLRAndroidManagement_PermissionGrant class], + @"roles" : [GTLRAndroidManagement_Role class], @"signingKeyCerts" : [GTLRAndroidManagement_ApplicationSigningKeyCert class] }; return map; @@ -2261,11 +2269,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRAndroidManagement_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRAndroidManagement_Operation class] + @"operations" : [GTLRAndroidManagement_Operation class], + @"unreachable" : [NSString class] }; return map; } @@ -2996,6 +3005,16 @@ @implementation GTLRAndroidManagement_RequestDeviceInfoStatus @end +// ---------------------------------------------------------------------------- +// +// GTLRAndroidManagement_Role +// + +@implementation GTLRAndroidManagement_Role +@dynamic roleType; +@end + + // ---------------------------------------------------------------------------- // // GTLRAndroidManagement_ScreenBrightnessSettings diff --git a/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementQuery.m b/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementQuery.m index 924876ed4..e1c09aba4 100644 --- a/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementQuery.m +++ b/Sources/GeneratedServices/AndroidManagement/GTLRAndroidManagementQuery.m @@ -227,7 +227,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRAndroidManagementQuery_EnterprisesDevicesOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementObjects.h b/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementObjects.h index dedce30f4..6eb04f7dc 100644 --- a/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementObjects.h +++ b/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementObjects.h @@ -135,6 +135,7 @@ @class GTLRAndroidManagement_RemoveEsimParams; @class GTLRAndroidManagement_RequestDeviceInfoParams; @class GTLRAndroidManagement_RequestDeviceInfoStatus; +@class GTLRAndroidManagement_Role; @class GTLRAndroidManagement_ScreenBrightnessSettings; @class GTLRAndroidManagement_ScreenTimeoutSettings; @class GTLRAndroidManagement_SecurityPosture; @@ -1298,11 +1299,12 @@ FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_ApplicationPolicy_Inst * until the app is installed. After installation, users won't be able to * remove the app. You can only set this installType for one app per policy. * When this is present in the policy, status bar will be automatically - * disabled. + * disabled.If there is any app with KIOSK role, then this install type cannot + * be set for any app. * * Value: "KIOSK" */ -FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_ApplicationPolicy_InstallType_Kiosk; +FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_ApplicationPolicy_InstallType_Kiosk GTLR_DEPRECATED; /** * The app is automatically installed and can be removed by the user. * @@ -1370,9 +1372,10 @@ FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_ApplicationPolicy_Pref /** * User control is allowed for the app. Kiosk apps can use this to allow user * control. For extension apps (see extensionConfig for more details), user - * control is disallowed even if this value is set. For kiosk apps (see KIOSK - * install type for more details), this value can be used to allow user - * control. + * control is disallowed even if this value is set.For apps with roles set to a + * nonempty list (except roles containing only KIOSK role), this value cannot + * be set.For kiosk apps (see KIOSK install type and KIOSK role type for more + * details), this value can be used to allow user control. * * Value: "USER_CONTROL_ALLOWED" */ @@ -1389,8 +1392,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_ApplicationPolicy_User * Uses the default behaviour of the app to determine if user control is * allowed or disallowed. User control is allowed by default for most apps but * disallowed for following types of apps: extension apps (see extensionConfig - * for more details) kiosk apps (see KIOSK install type for more details) other - * critical system apps + * for more details) kiosk apps (see KIOSK install type for more details) apps + * with roles set to a nonempty list other critical system apps * * Value: "USER_CONTROL_SETTINGS_UNSPECIFIED" */ @@ -5147,6 +5150,68 @@ FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_RequestDeviceInfoStatu */ FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_RequestDeviceInfoStatus_Status_UserDeclined; +// ---------------------------------------------------------------------------- +// GTLRAndroidManagement_Role.roleType + +/** + * The role type for companion apps. This role enables the app as a companion + * app with the capability of interacting with Android Device Policy offline. + * This is the recommended way to configure an app as a companion app. For + * legacy way, see extensionConfig.On Android 14 and above, the app with this + * role is exempted from power and background execution restrictions, + * suspension and hibernation. On Android 11 and above, the user control is + * disallowed for the app with this role. userControlSettings cannot be set to + * USER_CONTROL_ALLOWED for the app with this role.Android Device Policy + * notifies the companion app of any local command status updates if the app + * has a service with . See Integrate with the AMAPI SDK + * (https://developers.google.com/android/management/sdk-integration) guide for + * more details on the requirements for the service. + * + * Value: "COMPANION_APP" + */ +FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_Role_RoleType_CompanionApp; +/** + * The role type for kiosk apps. An app can have this role only if it has + * installType set to REQUIRED_FOR_SETUP or CUSTOM. Before adding this role to + * an app with CUSTOM install type, the app must already be installed on the + * device.The app having this role type is set as the preferred home intent and + * allowlisted for lock task mode. When there is an app with this role type, + * status bar will be automatically disabled.This is preferable to setting + * installType to KIOSK.On Android 11 and above, the user control is disallowed + * but userControlSettings can be set to USER_CONTROL_ALLOWED to allow user + * control for the app with this role. + * + * Value: "KIOSK" + */ +FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_Role_RoleType_Kiosk; +/** + * The role type for Mobile Threat Defense (MTD) / Endpoint Detection & + * Response (EDR) apps.On Android 14 and above, the app with this role is + * exempted from power and background execution restrictions, suspension and + * hibernation. On Android 11 and above, the user control is disallowed and + * userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with + * this role. + * + * Value: "MOBILE_THREAT_DEFENSE_ENDPOINT_DETECTION_RESPONSE" + */ +FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_Role_RoleType_MobileThreatDefenseEndpointDetectionResponse; +/** + * The role type is unspecified. This value must not be used. + * + * Value: "ROLE_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_Role_RoleType_RoleTypeUnspecified; +/** + * The role type for system health monitoring apps.On Android 14 and above, the + * app with this role is exempted from power and background execution + * restrictions, suspension and hibernation. On Android 11 and above, the user + * control is disallowed and userControlSettings cannot be set to + * USER_CONTROL_ALLOWED for the app with this role. + * + * Value: "SYSTEM_HEALTH_MONITORING" + */ +FOUNDATION_EXTERN NSString * const kGTLRAndroidManagement_Role_RoleType_SystemHealthMonitoring; + // ---------------------------------------------------------------------------- // GTLRAndroidManagement_ScreenBrightnessSettings.screenBrightnessMode @@ -6863,8 +6928,9 @@ GTLR_DEPRECATED /** * Configuration to enable this app as an extension app, with the capability of * interacting with Android Device Policy offline.This field can be set for at - * most one app.The signing key certificate fingerprint of the app on the - * device must match one of the entries in ApplicationPolicy.signingKeyCerts or + * most one app. If there is any app with COMPANION_APP role, this field cannot + * be set.The signing key certificate fingerprint of the app on the device must + * match one of the entries in ApplicationPolicy.signingKeyCerts or * ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key * certificate fingerprints obtained from Play Store for the app to be able to * communicate with Android Device Policy. If the app is not on Play Store and @@ -6872,7 +6938,7 @@ GTLR_DEPRECATED * ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a * NonComplianceDetail with INVALID_VALUE is reported. */ -@property(nonatomic, strong, nullable) GTLRAndroidManagement_ExtensionConfig *extensionConfig; +@property(nonatomic, strong, nullable) GTLRAndroidManagement_ExtensionConfig *extensionConfig GTLR_DEPRECATED; /** * Optional. The constraints for installing the app. You can specify a maximum @@ -6931,7 +6997,8 @@ GTLR_DEPRECATED * complete until the app is installed. After installation, users won't * be able to remove the app. You can only set this installType for one * app per policy. When this is present in the policy, status bar will be - * automatically disabled. (Value: "KIOSK") + * automatically disabled.If there is any app with KIOSK role, then this + * install type cannot be set for any app. (Value: "KIOSK") * @arg @c kGTLRAndroidManagement_ApplicationPolicy_InstallType_Preinstalled * The app is automatically installed and can be removed by the user. * (Value: "PREINSTALLED") @@ -7029,10 +7096,35 @@ GTLR_DEPRECATED */ @property(nonatomic, copy, nullable) NSString *preferentialNetworkId; +/** + * Optional. Roles the app has.Apps having certain roles can be exempted from + * power and background execution restrictions, suspension and hibernation on + * Android 14 and above. The user control can also be disallowed for apps with + * certain roles on Android 11 and above. Refer to the documentation of each + * RoleType for more details.The app is notified about the roles that are set + * for it if the app has a notification receiver service with . The app is + * notified whenever its roles are updated or after the app is installed when + * it has nonempty list of roles. The app can use this notification to + * bootstrap itself after the installation. See Integrate with the AMAPI SDK + * (https://developers.google.com/android/management/sdk-integration) and + * Manage app roles + * (https://developers.google.com/android/management/app-roles) guides for more + * details on the requirements for the service.For the exemptions to be applied + * and the app to be notified about the roles, the signing key certificate + * fingerprint of the app on the device must match one of the signing key + * certificate fingerprints obtained from Play Store or one of the entries in + * ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with + * APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with + * the same roleType. Multiple apps cannot hold a role with the same roleType. + * A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + */ +@property(nonatomic, strong, nullable) NSArray *roles; + /** * Optional. Signing key certificates of the app.This field is required in the * following cases: The app has installType set to CUSTOM (i.e. a custom app). - * The app has extensionConfig set (i.e. an extension app) but + * The app has roles set to a nonempty list and the app does not exist on the + * Play Store. The app has extensionConfig set (i.e. an extension app) but * ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the * app does not exist on the Play Store.If this field is not set for a custom * app, the policy is rejected. If it is not set when required for a non-custom @@ -7040,7 +7132,7 @@ GTLR_DEPRECATED * this field is optional and the signing key certificates obtained from Play * Store are used.See following policy settings to see how this field is used: * choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM - * ApplicationPolicy.extensionConfig + * ApplicationPolicy.extensionConfig ApplicationPolicy.roles */ @property(nonatomic, strong, nullable) NSArray *signingKeyCerts; @@ -7054,9 +7146,11 @@ GTLR_DEPRECATED * @arg @c kGTLRAndroidManagement_ApplicationPolicy_UserControlSettings_UserControlAllowed * User control is allowed for the app. Kiosk apps can use this to allow * user control. For extension apps (see extensionConfig for more - * details), user control is disallowed even if this value is set. For - * kiosk apps (see KIOSK install type for more details), this value can - * be used to allow user control. (Value: "USER_CONTROL_ALLOWED") + * details), user control is disallowed even if this value is set.For + * apps with roles set to a nonempty list (except roles containing only + * KIOSK role), this value cannot be set.For kiosk apps (see KIOSK + * install type and KIOSK role type for more details), this value can be + * used to allow user control. (Value: "USER_CONTROL_ALLOWED") * @arg @c kGTLRAndroidManagement_ApplicationPolicy_UserControlSettings_UserControlDisallowed * User control is disallowed for the app. This is supported on Android * 11 and above. A NonComplianceDetail with API_LEVEL is reported if the @@ -7066,8 +7160,8 @@ GTLR_DEPRECATED * allowed or disallowed. User control is allowed by default for most * apps but disallowed for following types of apps: extension apps (see * extensionConfig for more details) kiosk apps (see KIOSK install type - * for more details) other critical system apps (Value: - * "USER_CONTROL_SETTINGS_UNSPECIFIED") + * for more details) apps with roles set to a nonempty list other + * critical system apps (Value: "USER_CONTROL_SETTINGS_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *userControlSettings; @@ -9450,7 +9544,7 @@ GTLR_DEPRECATED * (https://developers.google.com/android/management/sdk-integration) guide for * more details). */ -@property(nonatomic, copy, nullable) NSString *notificationReceiver; +@property(nonatomic, copy, nullable) NSString *notificationReceiver GTLR_DEPRECATED; /** * Hex-encoded SHA-256 hashes of the signing key certificates of the extension @@ -10448,6 +10542,13 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * ListOperationsRequest.return_partial_success and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end @@ -13321,6 +13422,65 @@ GTLR_DEPRECATED @end +/** + * Role an app can have. + */ +@interface GTLRAndroidManagement_Role : GTLRObject + +/** + * Required. The type of the role an app can have. + * + * Likely values: + * @arg @c kGTLRAndroidManagement_Role_RoleType_CompanionApp The role type + * for companion apps. This role enables the app as a companion app with + * the capability of interacting with Android Device Policy offline. This + * is the recommended way to configure an app as a companion app. For + * legacy way, see extensionConfig.On Android 14 and above, the app with + * this role is exempted from power and background execution + * restrictions, suspension and hibernation. On Android 11 and above, the + * user control is disallowed for the app with this role. + * userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app + * with this role.Android Device Policy notifies the companion app of any + * local command status updates if the app has a service with . See + * Integrate with the AMAPI SDK + * (https://developers.google.com/android/management/sdk-integration) + * guide for more details on the requirements for the service. (Value: + * "COMPANION_APP") + * @arg @c kGTLRAndroidManagement_Role_RoleType_Kiosk The role type for kiosk + * apps. An app can have this role only if it has installType set to + * REQUIRED_FOR_SETUP or CUSTOM. Before adding this role to an app with + * CUSTOM install type, the app must already be installed on the + * device.The app having this role type is set as the preferred home + * intent and allowlisted for lock task mode. When there is an app with + * this role type, status bar will be automatically disabled.This is + * preferable to setting installType to KIOSK.On Android 11 and above, + * the user control is disallowed but userControlSettings can be set to + * USER_CONTROL_ALLOWED to allow user control for the app with this role. + * (Value: "KIOSK") + * @arg @c kGTLRAndroidManagement_Role_RoleType_MobileThreatDefenseEndpointDetectionResponse + * The role type for Mobile Threat Defense (MTD) / Endpoint Detection & + * Response (EDR) apps.On Android 14 and above, the app with this role is + * exempted from power and background execution restrictions, suspension + * and hibernation. On Android 11 and above, the user control is + * disallowed and userControlSettings cannot be set to + * USER_CONTROL_ALLOWED for the app with this role. (Value: + * "MOBILE_THREAT_DEFENSE_ENDPOINT_DETECTION_RESPONSE") + * @arg @c kGTLRAndroidManagement_Role_RoleType_RoleTypeUnspecified The role + * type is unspecified. This value must not be used. (Value: + * "ROLE_TYPE_UNSPECIFIED") + * @arg @c kGTLRAndroidManagement_Role_RoleType_SystemHealthMonitoring The + * role type for system health monitoring apps.On Android 14 and above, + * the app with this role is exempted from power and background execution + * restrictions, suspension and hibernation. On Android 11 and above, the + * user control is disallowed and userControlSettings cannot be set to + * USER_CONTROL_ALLOWED for the app with this role. (Value: + * "SYSTEM_HEALTH_MONITORING") + */ +@property(nonatomic, copy, nullable) NSString *roleType; + +@end + + /** * Controls for the screen brightness settings. */ diff --git a/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementQuery.h b/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementQuery.h index 7893ca5cb..5b1380bd1 100644 --- a/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementQuery.h +++ b/Sources/GeneratedServices/AndroidManagement/Public/GoogleAPIClientForREST/GTLRAndroidManagementQuery.h @@ -484,6 +484,17 @@ FOUNDATION_EXTERN NSString * const kGTLRAndroidManagementWipeDataFlagsWipeExtern /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when parent is set to + * "projects/example/locations/-".This field is not by default supported and + * will result in an UNIMPLEMENTED error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRAndroidManagement_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Apigee/GTLRApigeeObjects.m b/Sources/GeneratedServices/Apigee/GTLRApigeeObjects.m index 5df495f85..39c7b5b39 100644 --- a/Sources/GeneratedServices/Apigee/GTLRApigeeObjects.m +++ b/Sources/GeneratedServices/Apigee/GTLRApigeeObjects.m @@ -36,6 +36,7 @@ // GTLRApigee_GoogleCloudApigeeV1ApiProduct.quotaCounterScope NSString * const kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Operation = @"OPERATION"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Product = @"PRODUCT"; NSString * const kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Proxy = @"PROXY"; NSString * const kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_QuotaCounterScopeUnspecified = @"QUOTA_COUNTER_SCOPE_UNSPECIFIED"; @@ -167,6 +168,21 @@ NSString * const kGTLRApigee_GoogleCloudApigeeV1Instance_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRApigee_GoogleCloudApigeeV1Instance_State_Updating = @"UPDATING"; +// GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy.maintenanceChannel +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_MaintenanceChannelUnspecified = @"MAINTENANCE_CHANNEL_UNSPECIFIED"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_Week1 = @"WEEK1"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_Week2 = @"WEEK2"; + +// GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow.day +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_DayOfWeekUnspecified = @"DAY_OF_WEEK_UNSPECIFIED"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Friday = @"FRIDAY"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Monday = @"MONDAY"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Saturday = @"SATURDAY"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Sunday = @"SUNDAY"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Thursday = @"THURSDAY"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Tuesday = @"TUESDAY"; +NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Wednesday = @"WEDNESDAY"; + // GTLRApigee_GoogleCloudApigeeV1MetricAggregation.aggregation NSString * const kGTLRApigee_GoogleCloudApigeeV1MetricAggregation_Aggregation_AggregationFunctionUnspecified = @"AGGREGATION_FUNCTION_UNSPECIFIED"; NSString * const kGTLRApigee_GoogleCloudApigeeV1MetricAggregation_Aggregation_Avg = @"AVG"; @@ -2308,7 +2324,8 @@ @implementation GTLRApigee_GoogleCloudApigeeV1IngressConfig @implementation GTLRApigee_GoogleCloudApigeeV1Instance @dynamic accessLoggingConfig, consumerAcceptList, createdAt, descriptionProperty, diskEncryptionKeyName, displayName, host, ipRange, - lastModifiedAt, location, name, peeringCidrRange, port, runtimeVersion, + isVersionLocked, lastModifiedAt, location, maintenanceUpdatePolicy, + name, peeringCidrRange, port, runtimeVersion, scheduledMaintenance, serviceAttachment, state; + (NSDictionary *)propertyToJSONKeyMap { @@ -3310,6 +3327,34 @@ + (NSString *)collectionItemsKey { @end +// ---------------------------------------------------------------------------- +// +// GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy +// + +@implementation GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy +@dynamic maintenanceChannel, maintenanceWindows; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"maintenanceWindows" : [GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow +// + +@implementation GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow +@dynamic day, startTime; +@end + + // ---------------------------------------------------------------------------- // // GTLRApigee_GoogleCloudApigeeV1Metadata @@ -4264,6 +4309,16 @@ @implementation GTLRApigee_GoogleCloudApigeeV1RuntimeTraceSamplingConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRApigee_GoogleCloudApigeeV1ScheduledMaintenance +// + +@implementation GTLRApigee_GoogleCloudApigeeV1ScheduledMaintenance +@dynamic startTime; +@end + + // ---------------------------------------------------------------------------- // // GTLRApigee_GoogleCloudApigeeV1Schema @@ -5376,11 +5431,12 @@ @implementation GTLRApigee_GoogleIamV1TestIamPermissionsResponse // @implementation GTLRApigee_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRApigee_GoogleLongrunningOperation class] + @"operations" : [GTLRApigee_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } @@ -5537,3 +5593,13 @@ @implementation GTLRApigee_GoogleTypeInterval @implementation GTLRApigee_GoogleTypeMoney @dynamic currencyCode, nanos, units; @end + + +// ---------------------------------------------------------------------------- +// +// GTLRApigee_GoogleTypeTimeOfDay +// + +@implementation GTLRApigee_GoogleTypeTimeOfDay +@dynamic hours, minutes, nanos, seconds; +@end diff --git a/Sources/GeneratedServices/Apigee/GTLRApigeeQuery.m b/Sources/GeneratedServices/Apigee/GTLRApigeeQuery.m index e501e16c7..4e52713a3 100644 --- a/Sources/GeneratedServices/Apigee/GTLRApigeeQuery.m +++ b/Sources/GeneratedServices/Apigee/GTLRApigeeQuery.m @@ -6345,7 +6345,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRApigeeQuery_OrganizationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeObjects.h b/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeObjects.h index b9de7fe1b..ab17226fd 100644 --- a/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeObjects.h +++ b/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeObjects.h @@ -114,6 +114,8 @@ @class GTLRApigee_GoogleCloudApigeeV1KeyAliasReference; @class GTLRApigee_GoogleCloudApigeeV1KeystoreConfig; @class GTLRApigee_GoogleCloudApigeeV1KeyValueEntry; +@class GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy; +@class GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow; @class GTLRApigee_GoogleCloudApigeeV1Metadata; @class GTLRApigee_GoogleCloudApigeeV1Metric; @class GTLRApigee_GoogleCloudApigeeV1MetricAggregation; @@ -164,6 +166,7 @@ @class GTLRApigee_GoogleCloudApigeeV1RuntimeTraceConfig; @class GTLRApigee_GoogleCloudApigeeV1RuntimeTraceConfigOverride; @class GTLRApigee_GoogleCloudApigeeV1RuntimeTraceSamplingConfig; +@class GTLRApigee_GoogleCloudApigeeV1ScheduledMaintenance; @class GTLRApigee_GoogleCloudApigeeV1SchemaSchemaElement; @class GTLRApigee_GoogleCloudApigeeV1SchemaSchemaProperty; @class GTLRApigee_GoogleCloudApigeeV1Score; @@ -228,6 +231,7 @@ @class GTLRApigee_GoogleTypeExpr; @class GTLRApigee_GoogleTypeInterval; @class GTLRApigee_GoogleTypeMoney; +@class GTLRApigee_GoogleTypeTimeOfDay; // Generated comments include content from the discovery document; avoid them // causing warnings since clang's checks are some what arbitrary. @@ -329,6 +333,14 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1AnalyticsConfi * Value: "OPERATION" */ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Operation; +/** + * When quota is not explicitly defined for each operation(REST/GraphQL), the + * limits set at product level will be used as a global counter for quota + * evaluation by all the operations. + * + * Value: "PRODUCT" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Product; /** * When quota is not explicitly defined for each operation(REST/GraphQL), set * at product level will be used as a global counter for quota evaluation by @@ -985,6 +997,80 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1Instance_State */ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1Instance_State_Updating; +// ---------------------------------------------------------------------------- +// GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy.maintenanceChannel + +/** + * Unspecified maintenance channel. + * + * Value: "MAINTENANCE_CHANNEL_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_MaintenanceChannelUnspecified; +/** + * Receive 1 weeks notice before maintenance occurs + * + * Value: "WEEK1" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_Week1; +/** + * Receive 2 weeks notice before maintenance occurs + * + * Value: "WEEK2" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_Week2; + +// ---------------------------------------------------------------------------- +// GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow.day + +/** + * The day of the week is unspecified. + * + * Value: "DAY_OF_WEEK_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_DayOfWeekUnspecified; +/** + * Friday + * + * Value: "FRIDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Friday; +/** + * Monday + * + * Value: "MONDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Monday; +/** + * Saturday + * + * Value: "SATURDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Saturday; +/** + * Sunday + * + * Value: "SUNDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Sunday; +/** + * Thursday + * + * Value: "THURSDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Thursday; +/** + * Tuesday + * + * Value: "TUESDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Tuesday; +/** + * Wednesday + * + * Value: "WEDNESDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Wednesday; + // ---------------------------------------------------------------------------- // GTLRApigee_GoogleCloudApigeeV1MetricAggregation.aggregation @@ -2943,6 +3029,10 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType * quota evaluation by all the operations, independent of proxy * association. This behavior mimics the same as * QUOTA_COUNTER_SCOPE_UNSPECIFIED. (Value: "OPERATION") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Product + * When quota is not explicitly defined for each operation(REST/GraphQL), + * the limits set at product level will be used as a global counter for + * quota evaluation by all the operations. (Value: "PRODUCT") * @arg @c kGTLRApigee_GoogleCloudApigeeV1ApiProduct_QuotaCounterScope_Proxy * When quota is not explicitly defined for each operation(REST/GraphQL), * set at product level will be used as a global counter for quota @@ -6675,6 +6765,15 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType */ @property(nonatomic, copy, nullable) NSString *ipRange; +/** + * Output only. Indicates whether the instance is version locked. If true, the + * instance will not be updated by automated runtime rollouts. This is only + * supported for Apigee X instances. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isVersionLocked; + /** * Output only. Time the instance was last modified in milliseconds since * epoch. @@ -6686,6 +6785,12 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType /** Required. Compute Engine location where the instance resides. */ @property(nonatomic, copy, nullable) NSString *location; +/** + * Optional. Apigee customers can set the preferred window to perform + * maintenance on the instance (day of the week and time of day). + */ +@property(nonatomic, strong, nullable) GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy *maintenanceUpdatePolicy; + /** * Required. Resource ID of the instance. Values must match the regular * expression `^a-z{0,30}[a-z\\d]$`. @@ -6727,6 +6832,14 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType */ @property(nonatomic, copy, nullable) NSString *runtimeVersion; +/** + * Output only. Time and date of the scheduled maintenance for this instance. + * This field is only populated for instances that have opted into Maintenance + * Window and if there is an upcoming maintenance. Cleared once the maintenance + * is complete. + */ +@property(nonatomic, strong, nullable) GTLRApigee_GoogleCloudApigeeV1ScheduledMaintenance *scheduledMaintenance; + /** * Output only. Resource name of the service attachment created for the * instance in the format: `projects/ * /regions/ * /serviceAttachments/ *` @@ -7888,6 +8001,71 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType @end +/** + * MaintenanceUpdatePolicy specifies the preferred window to perform + * maintenance on the instance (day of the week and time of day). + */ +@interface GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy : GTLRObject + +/** + * Optional. Maintenance channel to specify relative scheduling for + * maintenance. + * + * Likely values: + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_MaintenanceChannelUnspecified + * Unspecified maintenance channel. (Value: + * "MAINTENANCE_CHANNEL_UNSPECIFIED") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_Week1 + * Receive 1 weeks notice before maintenance occurs (Value: "WEEK1") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicy_MaintenanceChannel_Week2 + * Receive 2 weeks notice before maintenance occurs (Value: "WEEK2") + */ +@property(nonatomic, copy, nullable) NSString *maintenanceChannel; + +/** + * Optional. Preferred windows to perform maintenance. Currently limited to 1. + */ +@property(nonatomic, strong, nullable) NSArray *maintenanceWindows; + +@end + + +/** + * MaintenanceWindow specifies the preferred day of the week and time of day to + * perform maintenance. + */ +@interface GTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow : GTLRObject + +/** + * Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, + * etc. + * + * Likely values: + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_DayOfWeekUnspecified + * The day of the week is unspecified. (Value: "DAY_OF_WEEK_UNSPECIFIED") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Friday + * Friday (Value: "FRIDAY") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Monday + * Monday (Value: "MONDAY") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Saturday + * Saturday (Value: "SATURDAY") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Sunday + * Sunday (Value: "SUNDAY") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Thursday + * Thursday (Value: "THURSDAY") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Tuesday + * Tuesday (Value: "TUESDAY") + * @arg @c kGTLRApigee_GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow_Day_Wednesday + * Wednesday (Value: "WEDNESDAY") + */ +@property(nonatomic, copy, nullable) NSString *day; + +/** Required. The start time (UTC) of the maintenance window. */ +@property(nonatomic, strong, nullable) GTLRApigee_GoogleTypeTimeOfDay *startTime; + +@end + + /** * Encapsulates additional information about query execution. */ @@ -10108,6 +10286,17 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType @end +/** + * Scheduled maintenance information for an instance. + */ +@interface GTLRApigee_GoogleCloudApigeeV1ScheduledMaintenance : GTLRObject + +/** Output only. The start time (UTC) of the scheduled maintenance. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; + +@end + + /** * Response for Schema call */ @@ -12666,6 +12855,13 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end @@ -12949,6 +13145,50 @@ FOUNDATION_EXTERN NSString * const kGTLRApigee_GoogleIamV1AuditLogConfig_LogType @end + +/** + * Represents a time of day. The date and time zone are either not significant + * or are specified elsewhere. An API may choose to allow leap seconds. Related + * types are google.type.Date and `google.protobuf.Timestamp`. + */ +@interface GTLRApigee_GoogleTypeTimeOfDay : GTLRObject + +/** + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and + * typically must be less than or equal to 23. An API may choose to allow the + * value "24:00:00" for scenarios like business closing time. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *hours; + +/** + * Minutes of an hour. Must be greater than or equal to 0 and less than or + * equal to 59. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *minutes; + +/** + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and + * less than or equal to 999,999,999. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *nanos; + +/** + * Seconds of a minute. Must be greater than or equal to 0 and typically must + * be less than or equal to 59. An API may allow the value 60 if it allows + * leap-seconds. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *seconds; + +@end + NS_ASSUME_NONNULL_END #pragma clang diagnostic pop diff --git a/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeQuery.h b/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeQuery.h index 58c17e079..f3b70005f 100644 --- a/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeQuery.h +++ b/Sources/GeneratedServices/Apigee/Public/GoogleAPIClientForREST/GTLRApigeeQuery.h @@ -12350,6 +12350,17 @@ FOUNDATION_EXTERN NSString * const kGTLRApigeeViewIngressConfigViewUnspecified; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRApigee_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/Appengine/GTLRAppengineObjects.m b/Sources/GeneratedServices/Appengine/GTLRAppengineObjects.m index 3bba3eb80..f35e91aa1 100644 --- a/Sources/GeneratedServices/Appengine/GTLRAppengineObjects.m +++ b/Sources/GeneratedServices/Appengine/GTLRAppengineObjects.m @@ -842,11 +842,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRAppengine_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRAppengine_Operation class] + @"operations" : [GTLRAppengine_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Appengine/GTLRAppengineQuery.m b/Sources/GeneratedServices/Appengine/GTLRAppengineQuery.m index c12d1324c..3c36d54a2 100644 --- a/Sources/GeneratedServices/Appengine/GTLRAppengineQuery.m +++ b/Sources/GeneratedServices/Appengine/GTLRAppengineQuery.m @@ -593,7 +593,7 @@ + (instancetype)queryWithAppsId:(NSString *)appsId @implementation GTLRAppengineQuery_AppsOperationsList -@dynamic appsId, filter, pageSize, pageToken; +@dynamic appsId, filter, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithAppsId:(NSString *)appsId { NSArray *pathParams = @[ @"appsId" ]; @@ -1221,6 +1221,33 @@ + (instancetype)queryWithObject:(GTLRAppengine_DomainMapping *)object @end +@implementation GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsDelete + +@dynamic applicationsId, domainMappingsId, locationsId, projectsId; + ++ (instancetype)queryWithProjectsId:(NSString *)projectsId + locationsId:(NSString *)locationsId + applicationsId:(NSString *)applicationsId + domainMappingsId:(NSString *)domainMappingsId { + NSArray *pathParams = @[ + @"applicationsId", @"domainMappingsId", @"locationsId", @"projectsId" + ]; + NSString *pathURITemplate = @"v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}"; + GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.projectsId = projectsId; + query.locationsId = locationsId; + query.applicationsId = applicationsId; + query.domainMappingsId = domainMappingsId; + query.expectedObjectClass = [GTLRAppengine_Operation class]; + query.loggingName = @"appengine.projects.locations.applications.domainMappings.delete"; + return query; +} + +@end + @implementation GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsGet @dynamic applicationsId, domainMappingsId, locationsId, projectsId; @@ -1248,6 +1275,41 @@ + (instancetype)queryWithProjectsId:(NSString *)projectsId @end +@implementation GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsPatch + +@dynamic applicationsId, domainMappingsId, locationsId, projectsId, updateMask; + ++ (instancetype)queryWithObject:(GTLRAppengine_DomainMapping *)object + projectsId:(NSString *)projectsId + locationsId:(NSString *)locationsId + applicationsId:(NSString *)applicationsId + domainMappingsId:(NSString *)domainMappingsId { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ + @"applicationsId", @"domainMappingsId", @"locationsId", @"projectsId" + ]; + NSString *pathURITemplate = @"v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}"; + GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.projectsId = projectsId; + query.locationsId = locationsId; + query.applicationsId = applicationsId; + query.domainMappingsId = domainMappingsId; + query.expectedObjectClass = [GTLRAppengine_Operation class]; + query.loggingName = @"appengine.projects.locations.applications.domainMappings.patch"; + return query; +} + +@end + @implementation GTLRAppengineQuery_ProjectsLocationsApplicationsPatch @dynamic applicationsId, locationsId, projectsId, updateMask; diff --git a/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineObjects.h b/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineObjects.h index c83aaff23..77d17ad82 100644 --- a/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineObjects.h +++ b/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineObjects.h @@ -2722,6 +2722,13 @@ FOUNDATION_EXTERN NSString * const kGTLRAppengine_VpcAccessConnector_EgressSetti */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * ListOperationsRequest.return_partial_success and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineQuery.h b/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineQuery.h index 2c374fa99..078ed480d 100644 --- a/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineQuery.h +++ b/Sources/GeneratedServices/Appengine/Public/GoogleAPIClientForREST/GTLRAppengineQuery.h @@ -1051,8 +1051,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAppengineViewFullCertificate; @property(nonatomic, copy, nullable) NSString *appsId; /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -1155,6 +1155,17 @@ FOUNDATION_EXTERN NSString * const kGTLRAppengineViewFullCertificate; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when parent is set to + * "projects/example/locations/-".This field is not by default supported and + * will result in an UNIMPLEMENTED error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRAppengine_ListOperationsResponse. * @@ -2375,6 +2386,55 @@ FOUNDATION_EXTERN NSString * const kGTLRAppengineViewFullCertificate; @end +/** + * Deletes the specified domain mapping. A user must be authorized to + * administer the associated domain in order to delete a DomainMapping + * resource. + * + * Method: appengine.projects.locations.applications.domainMappings.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeAppengineCloudPlatform + */ +@interface GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsDelete : GTLRAppengineQuery + +/** Part of `name`. See documentation of `projectsId`. */ +@property(nonatomic, copy, nullable) NSString *applicationsId; + +/** Part of `name`. See documentation of `projectsId`. */ +@property(nonatomic, copy, nullable) NSString *domainMappingsId; + +/** Part of `name`. See documentation of `projectsId`. */ +@property(nonatomic, copy, nullable) NSString *locationsId; + +/** + * Part of `name`. Required. Name of the resource to delete. Example: + * apps/myapp/domainMappings/example.com. + */ +@property(nonatomic, copy, nullable) NSString *projectsId; + +/** + * Fetches a @c GTLRAppengine_Operation. + * + * Deletes the specified domain mapping. A user must be authorized to + * administer the associated domain in order to delete a DomainMapping + * resource. + * + * @param projectsId Part of `name`. Required. Name of the resource to delete. + * Example: apps/myapp/domainMappings/example.com. + * @param locationsId Part of `name`. See documentation of `projectsId`. + * @param applicationsId Part of `name`. See documentation of `projectsId`. + * @param domainMappingsId Part of `name`. See documentation of `projectsId`. + * + * @return GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsDelete + */ ++ (instancetype)queryWithProjectsId:(NSString *)projectsId + locationsId:(NSString *)locationsId + applicationsId:(NSString *)applicationsId + domainMappingsId:(NSString *)domainMappingsId; + +@end + /** * Gets the specified domain mapping. * @@ -2422,6 +2482,66 @@ FOUNDATION_EXTERN NSString * const kGTLRAppengineViewFullCertificate; @end +/** + * Updates the specified domain mapping. To map an SSL certificate to a domain + * mapping, update certificate_id to point to an AuthorizedCertificate + * resource. A user must be authorized to administer the associated domain in + * order to update a DomainMapping resource. + * + * Method: appengine.projects.locations.applications.domainMappings.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeAppengineCloudPlatform + */ +@interface GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsPatch : GTLRAppengineQuery + +/** Part of `name`. See documentation of `projectsId`. */ +@property(nonatomic, copy, nullable) NSString *applicationsId; + +/** Part of `name`. See documentation of `projectsId`. */ +@property(nonatomic, copy, nullable) NSString *domainMappingsId; + +/** Part of `name`. See documentation of `projectsId`. */ +@property(nonatomic, copy, nullable) NSString *locationsId; + +/** + * Part of `name`. Required. Name of the resource to update. Example: + * apps/myapp/domainMappings/example.com. + */ +@property(nonatomic, copy, nullable) NSString *projectsId; + +/** + * Required. Standard field mask for the set of fields to be updated. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLRAppengine_Operation. + * + * Updates the specified domain mapping. To map an SSL certificate to a domain + * mapping, update certificate_id to point to an AuthorizedCertificate + * resource. A user must be authorized to administer the associated domain in + * order to update a DomainMapping resource. + * + * @param object The @c GTLRAppengine_DomainMapping to include in the query. + * @param projectsId Part of `name`. Required. Name of the resource to update. + * Example: apps/myapp/domainMappings/example.com. + * @param locationsId Part of `name`. See documentation of `projectsId`. + * @param applicationsId Part of `name`. See documentation of `projectsId`. + * @param domainMappingsId Part of `name`. See documentation of `projectsId`. + * + * @return GTLRAppengineQuery_ProjectsLocationsApplicationsDomainMappingsPatch + */ ++ (instancetype)queryWithObject:(GTLRAppengine_DomainMapping *)object + projectsId:(NSString *)projectsId + locationsId:(NSString *)locationsId + applicationsId:(NSString *)applicationsId + domainMappingsId:(NSString *)domainMappingsId; + +@end + /** * Updates the specified Application resource. You can update the following * fields: auth_domain - Google authentication domain for controlling user diff --git a/Sources/GeneratedServices/ArtifactRegistry/Public/GoogleAPIClientForREST/GTLRArtifactRegistryQuery.h b/Sources/GeneratedServices/ArtifactRegistry/Public/GoogleAPIClientForREST/GTLRArtifactRegistryQuery.h index 9b7c6dbcc..5e4c0f1c1 100644 --- a/Sources/GeneratedServices/ArtifactRegistry/Public/GoogleAPIClientForREST/GTLRArtifactRegistryQuery.h +++ b/Sources/GeneratedServices/ArtifactRegistry/Public/GoogleAPIClientForREST/GTLRArtifactRegistryQuery.h @@ -156,8 +156,8 @@ FOUNDATION_EXTERN NSString * const kGTLRArtifactRegistryViewVersionViewUnspecifi @interface GTLRArtifactRegistryQuery_ProjectsLocationsList : GTLRArtifactRegistryQuery /** - * Optional. A list of extra location types that should be used as conditions - * for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/Backupdr/GTLRBackupdrObjects.m b/Sources/GeneratedServices/Backupdr/GTLRBackupdrObjects.m index 245ef03a1..65e35d22b 100644 --- a/Sources/GeneratedServices/Backupdr/GTLRBackupdrObjects.m +++ b/Sources/GeneratedServices/Backupdr/GTLRBackupdrObjects.m @@ -432,6 +432,31 @@ @implementation GTLRBackupdr_AllocationAffinity @end +// ---------------------------------------------------------------------------- +// +// GTLRBackupdr_AlloyDbClusterBackupProperties +// + +@implementation GTLRBackupdr_AlloyDbClusterBackupProperties +@dynamic chainId, databaseVersion, descriptionProperty, storedBytes; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBackupdr_AlloyDBClusterDataSourceProperties +// + +@implementation GTLRBackupdr_AlloyDBClusterDataSourceProperties +@dynamic name; +@end + + // ---------------------------------------------------------------------------- // // GTLRBackupdr_AttachedDisk @@ -501,12 +526,12 @@ @implementation GTLRBackupdr_AuditLogConfig // @implementation GTLRBackupdr_Backup -@dynamic backupApplianceBackupProperties, backupApplianceLocks, backupType, - cloudSqlInstanceBackupProperties, computeInstanceBackupProperties, - consistencyTime, createTime, descriptionProperty, diskBackupProperties, - enforcedRetentionEndTime, ETag, expireTime, gcpBackupPlanInfo, labels, - name, resourceSizeBytes, satisfiesPzi, satisfiesPzs, serviceLocks, - state, updateTime; +@dynamic alloyDbBackupProperties, backupApplianceBackupProperties, + backupApplianceLocks, backupType, cloudSqlInstanceBackupProperties, + computeInstanceBackupProperties, consistencyTime, createTime, + descriptionProperty, diskBackupProperties, enforcedRetentionEndTime, + ETag, expireTime, gcpBackupPlanInfo, labels, name, resourceSizeBytes, + satisfiesPzi, satisfiesPzs, serviceLocks, state, updateTime; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -1044,7 +1069,8 @@ @implementation GTLRBackupdr_DataSourceBackupConfigInfo // @implementation GTLRBackupdr_DataSourceGcpResource -@dynamic cloudSqlInstanceDatasourceProperties, +@dynamic alloyDbClusterDatasourceProperties, + cloudSqlInstanceDatasourceProperties, computeInstanceDatasourceProperties, diskDatasourceProperties, gcpResourcename, location, type; @end diff --git a/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrObjects.h b/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrObjects.h index 987c67b92..b20e84870 100644 --- a/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrObjects.h +++ b/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrObjects.h @@ -17,6 +17,8 @@ @class GTLRBackupdr_AdvancedMachineFeatures; @class GTLRBackupdr_AliasIpRange; @class GTLRBackupdr_AllocationAffinity; +@class GTLRBackupdr_AlloyDbClusterBackupProperties; +@class GTLRBackupdr_AlloyDBClusterDataSourceProperties; @class GTLRBackupdr_AttachedDisk; @class GTLRBackupdr_AuditConfig; @class GTLRBackupdr_AuditLogConfig; @@ -2020,6 +2022,54 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdr_WeekDayOfMonth_WeekOfMonth_Week @end +/** + * AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. + * . + */ +@interface GTLRBackupdr_AlloyDbClusterBackupProperties : GTLRObject + +/** + * Output only. The chain id of this backup. Backups belonging to the same + * chain are sharing the same chain id. This property is calculated and + * maintained by BackupDR. + */ +@property(nonatomic, copy, nullable) NSString *chainId; + +/** + * Output only. The PostgreSQL major version of the AlloyDB cluster when the + * backup was taken. + */ +@property(nonatomic, copy, nullable) NSString *databaseVersion; + +/** + * An optional text description for the backup. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** + * Output only. Storage usage of this particular backup + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *storedBytes; + +@end + + +/** + * AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB + * cluster resource that are stored in the DataSource. . + */ +@interface GTLRBackupdr_AlloyDBClusterDataSourceProperties : GTLRObject + +/** Output only. Name of the AlloyDB cluster backed up by the datasource. */ +@property(nonatomic, copy, nullable) NSString *name; + +@end + + /** * An instance-attached disk resource. */ @@ -2244,6 +2294,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdr_WeekDayOfMonth_WeekOfMonth_Week */ @interface GTLRBackupdr_Backup : GTLRObject +/** Output only. AlloyDB specific backup properties. */ +@property(nonatomic, strong, nullable) GTLRBackupdr_AlloyDbClusterBackupProperties *alloyDbBackupProperties; + /** Output only. Backup Appliance specific backup properties. */ @property(nonatomic, strong, nullable) GTLRBackupdr_BackupApplianceBackupProperties *backupApplianceBackupProperties; @@ -3999,6 +4052,14 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdr_WeekDayOfMonth_WeekOfMonth_Week */ @interface GTLRBackupdr_DataSourceGcpResource : GTLRObject +/** + * Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB + * cluster properties that are useful at the Datasource level. Currently none + * of its child properties are auditable. If new auditable properties are + * added, the AUDIT annotation should be added. + */ +@property(nonatomic, strong, nullable) GTLRBackupdr_AlloyDBClusterDataSourceProperties *alloyDbClusterDatasourceProperties; + /** * Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL * Instance properties that are useful at the Datasource level. diff --git a/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrQuery.h b/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrQuery.h index 18d46f2a9..50ff6bdec 100644 --- a/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrQuery.h +++ b/Sources/GeneratedServices/Backupdr/Public/GoogleAPIClientForREST/GTLRBackupdrQuery.h @@ -1963,7 +1963,11 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdrViewBackupViewUnspecified; */ @interface GTLRBackupdrQuery_ProjectsLocationsGetTrial : GTLRBackupdrQuery -/** Required. The name of the trial to retrieve. */ +/** + * Required. The project for which trial details need to be retrieved. Format: + * projects/{project}/locations/{location} Supported Locations are - us, eu and + * asia. + */ @property(nonatomic, copy, nullable) NSString *name; /** @@ -1971,7 +1975,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdrViewBackupViewUnspecified; * * Gets the Trial state for a given project * - * @param name Required. The name of the trial to retrieve. + * @param name Required. The project for which trial details need to be + * retrieved. Format: projects/{project}/locations/{location} Supported + * Locations are - us, eu and asia. * * @return GTLRBackupdrQuery_ProjectsLocationsGetTrial */ @@ -1990,8 +1996,8 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdrViewBackupViewUnspecified; @interface GTLRBackupdrQuery_ProjectsLocationsList : GTLRBackupdrQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -2636,7 +2642,11 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdrViewBackupViewUnspecified; */ @interface GTLRBackupdrQuery_ProjectsLocationsTrialSubscribe : GTLRBackupdrQuery -/** Required. The parent resource where this trial will be created. */ +/** + * Required. The project where this trial will be created. Format: + * projects/{project}/locations/{location} Supported Locations are - us, eu and + * asia. + */ @property(nonatomic, copy, nullable) NSString *parent; /** @@ -2646,8 +2656,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupdrViewBackupViewUnspecified; * * @param object The @c GTLRBackupdr_SubscribeTrialRequest to include in the * query. - * @param parent Required. The parent resource where this trial will be - * created. + * @param parent Required. The project where this trial will be created. + * Format: projects/{project}/locations/{location} Supported Locations are - + * us, eu and asia. * * @return GTLRBackupdrQuery_ProjectsLocationsTrialSubscribe */ diff --git a/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEObjects.h b/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEObjects.h index 0a44338b9..73d90655a 100644 --- a/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEObjects.h +++ b/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEObjects.h @@ -1896,7 +1896,7 @@ FOUNDATION_EXTERN NSString * const kGTLRBackupforGKE_VolumeRestore_VolumeType_Vo @property(nonatomic, strong, nullable) GTLRBackupforGKE_Date *singleOccurrenceDate; /** - * Required. Specifies the start time of the window using time of the day in + * Optional. Specifies the start time of the window using time of the day in * UTC. */ @property(nonatomic, strong, nullable) GTLRBackupforGKE_TimeOfDay *startTime; diff --git a/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEQuery.h b/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEQuery.h index 8f0126052..48ae7c4dd 100644 --- a/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEQuery.h +++ b/Sources/GeneratedServices/BackupforGKE/Public/GoogleAPIClientForREST/GTLRBackupforGKEQuery.h @@ -1326,8 +1326,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRBackupforGKEQuery_ProjectsLocationsList : GTLRBackupforGKEQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/BeyondCorp/GTLRBeyondCorpObjects.m b/Sources/GeneratedServices/BeyondCorp/GTLRBeyondCorpObjects.m index 995e35c56..05aa4cbc4 100644 --- a/Sources/GeneratedServices/BeyondCorp/GTLRBeyondCorpObjects.m +++ b/Sources/GeneratedServices/BeyondCorp/GTLRBeyondCorpObjects.m @@ -63,6 +63,39 @@ NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo_Status_Unhealthy = @"UNHEALTHY"; NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo_Status_Unresponsive = @"UNRESPONSIVE"; +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application.schema +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_ApiGateway = @"API_GATEWAY"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_ProxyGateway = @"PROXY_GATEWAY"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_SchemaUnspecified = @"SCHEMA_UNSPECIFIED"; + +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders.outputType +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_Json = @"JSON"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_None = @"NONE"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_OutputTypeUnspecified = @"OUTPUT_TYPE_UNSPECIFIED"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_Protobuf = @"PROTOBUF"; + +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo.outputType +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_Json = @"JSON"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_None = @"NONE"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_OutputTypeUnspecified = @"OUTPUT_TYPE_UNSPECIFIED"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_Protobuf = @"PROTOBUF"; + +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo.outputType +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_Json = @"JSON"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_None = @"NONE"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_OutputTypeUnspecified = @"OUTPUT_TYPE_UNSPECIFIED"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_Protobuf = @"PROTOBUF"; + +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo.outputType +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_Json = @"JSON"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_None = @"NONE"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_OutputTypeUnspecified = @"OUTPUT_TYPE_UNSPECIFIED"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_Protobuf = @"PROTOBUF"; + +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig.gatewayIdentity +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_GatewayIdentity_GatewayIdentityUnspecified = @"GATEWAY_IDENTITY_UNSPECIFIED"; +NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_GatewayIdentity_ResourceName = @"RESOURCE_NAME"; + // GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway.state NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway_State_Creating = @"CREATING"; NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway_State_Deleting = @"DELETING"; @@ -703,7 +736,8 @@ @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecur // @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application -@dynamic createTime, displayName, endpointMatchers, name, updateTime, upstreams; +@dynamic createTime, displayName, endpointMatchers, name, schema, updateTime, + upstreams; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -722,7 +756,25 @@ @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Applicatio // @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream -@dynamic egressPolicy, network; +@dynamic egressPolicy, external, network, proxyProtocol; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal +@dynamic endpoints; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"endpoints" : [GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint class] + }; + return map; +} + @end @@ -736,6 +788,46 @@ @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Applicatio @end +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders +@dynamic deviceInfo, groupInfo, outputType, userInfo; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo +@dynamic outputType; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo +@dynamic outputType; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo +@dynamic outputType; +@end + + // ---------------------------------------------------------------------------- // // GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy @@ -754,6 +846,16 @@ @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1EgressPoli @end +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint +@dynamic hostname, port; +@end + + // ---------------------------------------------------------------------------- // // GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher @@ -846,6 +948,39 @@ + (NSString *)collectionItemsKey { @end +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig +@dynamic allowedClientHeaders, clientIp, contextualHeaders, gatewayIdentity, + metadataHeaders; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"allowedClientHeaders" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_MetadataHeaders +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_MetadataHeaders + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway @@ -853,7 +988,7 @@ + (NSString *)collectionItemsKey { @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway @dynamic createTime, delegatingServiceAccount, displayName, externalIps, hubs, - name, state, updateTime; + name, proxyProtocolConfig, serviceDiscovery, state, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -890,6 +1025,36 @@ @implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGa @end +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery +@dynamic apiGateway; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway +@dynamic resourceOverride; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor +// + +@implementation GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor +@dynamic path; +@end + + // ---------------------------------------------------------------------------- // // GTLRBeyondCorp_GoogleCloudLocationListLocationsResponse diff --git a/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpObjects.h b/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpObjects.h index 247c30b2a..6cc487f0f 100644 --- a/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpObjects.h +++ b/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpObjects.h @@ -42,13 +42,24 @@ @class GTLRBeyondCorp_GoogleCloudBeyondcorpConnectorsV1alphaContainerHealthDetails_ExtendedStatus; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Hub; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1InternetGateway; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_MetadataHeaders; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway; @class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway_Hubs; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway; +@class GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor; @class GTLRBeyondCorp_GoogleCloudLocationLocation; @class GTLRBeyondCorp_GoogleCloudLocationLocation_Labels; @class GTLRBeyondCorp_GoogleCloudLocationLocation_Metadata; @@ -295,6 +306,157 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpAppconne */ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo_Status_Unresponsive; +// ---------------------------------------------------------------------------- +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application.schema + +/** + * Service Discovery API endpoint when Service Discovery is enabled in Gateway. + * + * Value: "API_GATEWAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_ApiGateway; +/** + * Proxy which routes traffic to actual applications, like Netscaler Gateway. + * + * Value: "PROXY_GATEWAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_ProxyGateway; +/** + * Default value. This value is unused. + * + * Value: "SCHEMA_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_SchemaUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders.outputType + +/** + * JSON output type. + * + * Value: "JSON" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_Json; +/** + * Explicitly disable header output. + * + * Value: "NONE" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_None; +/** + * Unspecified output type. + * + * Value: "OUTPUT_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_OutputTypeUnspecified; +/** + * Protobuf output type. + * + * Value: "PROTOBUF" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_Protobuf; + +// ---------------------------------------------------------------------------- +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo.outputType + +/** + * JSON output type. + * + * Value: "JSON" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_Json; +/** + * Explicitly disable header output. + * + * Value: "NONE" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_None; +/** + * Unspecified output type. + * + * Value: "OUTPUT_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_OutputTypeUnspecified; +/** + * Protobuf output type. + * + * Value: "PROTOBUF" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_Protobuf; + +// ---------------------------------------------------------------------------- +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo.outputType + +/** + * JSON output type. + * + * Value: "JSON" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_Json; +/** + * Explicitly disable header output. + * + * Value: "NONE" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_None; +/** + * Unspecified output type. + * + * Value: "OUTPUT_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_OutputTypeUnspecified; +/** + * Protobuf output type. + * + * Value: "PROTOBUF" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_Protobuf; + +// ---------------------------------------------------------------------------- +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo.outputType + +/** + * JSON output type. + * + * Value: "JSON" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_Json; +/** + * Explicitly disable header output. + * + * Value: "NONE" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_None; +/** + * Unspecified output type. + * + * Value: "OUTPUT_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_OutputTypeUnspecified; +/** + * Protobuf output type. + * + * Value: "PROTOBUF" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_Protobuf; + +// ---------------------------------------------------------------------------- +// GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig.gatewayIdentity + +/** + * Unspecified gateway identity. + * + * Value: "GATEWAY_IDENTITY_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_GatewayIdentity_GatewayIdentityUnspecified; +/** + * Resource name for gateway identity, in the format: + * projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id} + * + * Value: "RESOURCE_NAME" + */ +FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_GatewayIdentity_ResourceName; + // ---------------------------------------------------------------------------- // GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway.state @@ -1751,16 +1913,30 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log * hostname and ports as endpoint matchers is used to match the application. * Match conditions for OR logic. An array of match conditions to allow for * multiple matching criteria. The rule is considered a match if one of the - * conditions is met. The conditions can be one of the following combinations - * (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), - * ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), - * ("example.com" and "22,33") etc + * conditions is met. The conditions should be the following combination: + * (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), + * ("example.com" and "22"), ("example.com" and "22,33") etc */ @property(nonatomic, strong, nullable) NSArray *endpointMatchers; /** Identifier. Name of the resource. */ @property(nonatomic, copy, nullable) NSString *name; +/** + * Optional. Type of the external application. + * + * Likely values: + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_ApiGateway + * Service Discovery API endpoint when Service Discovery is enabled in + * Gateway. (Value: "API_GATEWAY") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_ProxyGateway + * Proxy which routes traffic to actual applications, like Netscaler + * Gateway. (Value: "PROXY_GATEWAY") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Application_Schema_SchemaUnspecified + * Default value. This value is unused. (Value: "SCHEMA_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *schema; + /** Output only. Timestamp when the resource was last modified. */ @property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @@ -1778,9 +1954,26 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log /** Optional. Routing policy information. */ @property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy *egressPolicy; +/** List of the external endpoints to forward traffic to. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal *external; + /** Network to forward traffic to. */ @property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork *network; +/** Optional. Enables proxy protocol configuration for the upstream. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig *proxyProtocol; + +@end + + +/** + * Endpoints to forward traffic to. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal : GTLRObject + +/** Required. List of the endpoints to forward traffic to. */ +@property(nonatomic, strong, nullable) NSArray *endpoints; + @end @@ -1798,6 +1991,107 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log @end +/** + * Contextual headers configuration. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders : GTLRObject + +/** Optional. Device info configuration. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo *deviceInfo; + +/** Optional. Group info configuration. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo *groupInfo; + +/** + * Optional. Default output type for all enabled headers. + * + * Likely values: + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_Json + * JSON output type. (Value: "JSON") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_None + * Explicitly disable header output. (Value: "NONE") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_OutputTypeUnspecified + * Unspecified output type. (Value: "OUTPUT_TYPE_UNSPECIFIED") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders_OutputType_Protobuf + * Protobuf output type. (Value: "PROTOBUF") + */ +@property(nonatomic, copy, nullable) NSString *outputType; + +/** Optional. User info configuration. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo *userInfo; + +@end + + +/** + * Delegated device info configuration. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo : GTLRObject + +/** + * Optional. The output type of the delegated device info. + * + * Likely values: + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_Json + * JSON output type. (Value: "JSON") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_None + * Explicitly disable header output. (Value: "NONE") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_OutputTypeUnspecified + * Unspecified output type. (Value: "OUTPUT_TYPE_UNSPECIFIED") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo_OutputType_Protobuf + * Protobuf output type. (Value: "PROTOBUF") + */ +@property(nonatomic, copy, nullable) NSString *outputType; + +@end + + +/** + * Delegated group info configuration. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo : GTLRObject + +/** + * Optional. The output type of the delegated group info. + * + * Likely values: + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_Json + * JSON output type. (Value: "JSON") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_None + * Explicitly disable header output. (Value: "NONE") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_OutputTypeUnspecified + * Unspecified output type. (Value: "OUTPUT_TYPE_UNSPECIFIED") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo_OutputType_Protobuf + * Protobuf output type. (Value: "PROTOBUF") + */ +@property(nonatomic, copy, nullable) NSString *outputType; + +@end + + +/** + * Delegated user info configuration. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo : GTLRObject + +/** + * Optional. The output type of the delegated user info. + * + * Likely values: + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_Json + * JSON output type. (Value: "JSON") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_None + * Explicitly disable header output. (Value: "NONE") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_OutputTypeUnspecified + * Unspecified output type. (Value: "OUTPUT_TYPE_UNSPECIFIED") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo_OutputType_Protobuf + * Protobuf output type. (Value: "PROTOBUF") + */ +@property(nonatomic, copy, nullable) NSString *outputType; + +@end + + /** * Routing policy information. */ @@ -1809,6 +2103,24 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log @end +/** + * Internet Gateway endpoint to forward traffic to. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint : GTLRObject + +/** Required. Hostname of the endpoint. */ +@property(nonatomic, copy, nullable) NSString *hostname; + +/** + * Required. Port of the endpoint. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *port; + +@end + + /** * EndpointMatcher contains the information of the endpoint that will match the * application. @@ -1819,7 +2131,7 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log @property(nonatomic, copy, nullable) NSString *hostname; /** - * Optional. Ports of the application. + * Required. Ports of the application. * * Uses NSNumber of intValue. */ @@ -1911,6 +2223,64 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log @end +/** + * The configuration for the proxy. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig : GTLRObject + +/** Optional. List of the allowed client header names. */ +@property(nonatomic, strong, nullable) NSArray *allowedClientHeaders; + +/** + * Optional. Client IP configuration. The client IP address is included if + * true. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *clientIp; + +/** Optional. Configuration for the contextual headers. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders *contextualHeaders; + +/** + * Optional. Gateway identity configuration. + * + * Likely values: + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_GatewayIdentity_GatewayIdentityUnspecified + * Unspecified gateway identity. (Value: "GATEWAY_IDENTITY_UNSPECIFIED") + * @arg @c kGTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_GatewayIdentity_ResourceName + * Resource name for gateway identity, in the format: + * projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id} + * (Value: "RESOURCE_NAME") + */ +@property(nonatomic, copy, nullable) NSString *gatewayIdentity; + +/** + * Optional. Custom resource specific headers along with the values. The names + * should conform to RFC 9110: > Field names SHOULD constrain themselves to + * alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field + * values SHOULD contain only ASCII printable characters and tab. + */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_MetadataHeaders *metadataHeaders; + +@end + + +/** + * Optional. Custom resource specific headers along with the values. The names + * should conform to RFC 9110: > Field names SHOULD constrain themselves to + * alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field + * values SHOULD contain only ASCII printable characters and tab. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig_MetadataHeaders : GTLRObject +@end + + /** * The information about a security gateway resource. */ @@ -1946,6 +2316,12 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log /** Identifier. Name of the resource. */ @property(nonatomic, copy, nullable) NSString *name; +/** Optional. Shared proxy configuration for all apps. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig *proxyProtocolConfig; + +/** Optional. Settings related to the Service Discovery. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery *serviceDiscovery; + /** * Output only. The operational state of the SecurityGateway. * @@ -2027,6 +2403,42 @@ FOUNDATION_EXTERN NSString * const kGTLRBeyondCorp_GoogleIamV1AuditLogConfig_Log @end +/** + * Settings related to the Service Discovery. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery : GTLRObject + +/** Required. External API configuration. */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway *apiGateway; + +@end + + +/** + * If Service Discovery is done through API, defines its settings. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway : GTLRObject + +/** + * Required. Enables fetching resource model updates to alter service behavior + * per Chrome profile. + */ +@property(nonatomic, strong, nullable) GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor *resourceOverride; + +@end + + +/** + * API operation descriptor. + */ +@interface GTLRBeyondCorp_GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor : GTLRObject + +/** Required. Contains uri path fragment where HTTP request is sent. */ +@property(nonatomic, copy, nullable) NSString *path; + +@end + + /** * The response message for Locations.ListLocations. * diff --git a/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpQuery.h b/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpQuery.h index 07b1f12e6..9b77981a3 100644 --- a/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpQuery.h +++ b/Sources/GeneratedServices/BeyondCorp/Public/GoogleAPIClientForREST/GTLRBeyondCorpQuery.h @@ -1486,8 +1486,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRBeyondCorpQuery_ProjectsLocationsList : GTLRBeyondCorpQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/Bigquery/GTLRBigqueryObjects.m b/Sources/GeneratedServices/Bigquery/GTLRBigqueryObjects.m index aa7a6ac0a..4c6af9ac3 100644 --- a/Sources/GeneratedServices/Bigquery/GTLRBigqueryObjects.m +++ b/Sources/GeneratedServices/Bigquery/GTLRBigqueryObjects.m @@ -163,6 +163,10 @@ NSString * const kGTLRBigquery_HparamTuningTrial_Status_Succeeded = @"SUCCEEDED"; NSString * const kGTLRBigquery_HparamTuningTrial_Status_TrialStatusUnspecified = @"TRIAL_STATUS_UNSPECIFIED"; +// GTLRBigquery_IncrementalResultStats.disabledReason +NSString * const kGTLRBigquery_IncrementalResultStats_DisabledReason_DisabledReasonUnspecified = @"DISABLED_REASON_UNSPECIFIED"; +NSString * const kGTLRBigquery_IncrementalResultStats_DisabledReason_Other = @"OTHER"; + // GTLRBigquery_IndexUnusedReason.code NSString * const kGTLRBigquery_IndexUnusedReason_Code_BaseTableTooLarge = @"BASE_TABLE_TOO_LARGE"; NSString * const kGTLRBigquery_IndexUnusedReason_Code_BaseTableTooSmall = @"BASE_TABLE_TOO_SMALL"; @@ -686,6 +690,12 @@ NSString * const kGTLRBigquery_TrainingOptions_PcaSolver_Randomized = @"RANDOMIZED"; NSString * const kGTLRBigquery_TrainingOptions_PcaSolver_Unspecified = @"UNSPECIFIED"; +// GTLRBigquery_TrainingOptions.reservationAffinityType +NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_AnyReservation = @"ANY_RESERVATION"; +NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_NoReservation = @"NO_RESERVATION"; +NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_ReservationAffinityTypeUnspecified = @"RESERVATION_AFFINITY_TYPE_UNSPECIFIED"; +NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_SpecificReservation = @"SPECIFIC_RESERVATION"; + // GTLRBigquery_TrainingOptions.treeMethod NSString * const kGTLRBigquery_TrainingOptions_TreeMethod_Approx = @"APPROX"; NSString * const kGTLRBigquery_TrainingOptions_TreeMethod_Auto = @"AUTO"; @@ -1754,12 +1764,13 @@ @implementation GTLRBigquery_ExternalDataConfiguration ignoreUnknownValues, jsonExtension, jsonOptions, maxBadRecords, metadataCacheMode, objectMetadata, parquetOptions, referenceFileSchemaUri, schema, sourceFormat, sourceUris, timeFormat, - timestampFormat, timeZone; + timestampFormat, timestampTargetPrecision, timeZone; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @"decimalTargetTypes" : [NSString class], - @"sourceUris" : [NSString class] + @"sourceUris" : [NSString class], + @"timestampTargetPrecision" : [NSNumber class] }; return map; } @@ -1966,6 +1977,27 @@ @implementation GTLRBigquery_HparamTuningTrial @end +// ---------------------------------------------------------------------------- +// +// GTLRBigquery_IncrementalResultStats +// + +@implementation GTLRBigquery_IncrementalResultStats +@dynamic disabledReason, resultSetLastModifyTime, resultSetLastReplaceTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRBigquery_IndexPruningStats +// + +@implementation GTLRBigquery_IndexPruningStats +@dynamic baseTable, postIndexPruningParallelInputCount, + preIndexPruningParallelInputCount; +@end + + // ---------------------------------------------------------------------------- // // GTLRBigquery_IndexUnusedReason @@ -2179,8 +2211,8 @@ @implementation GTLRBigquery_JobConfigurationLoad rangePartitioning, referenceFileSchemaUri, schema, schemaInline, schemaInlineFormat, schemaUpdateOptions, skipLeadingRows, sourceColumnMatch, sourceFormat, sourceUris, timeFormat, - timePartitioning, timestampFormat, timeZone, useAvroLogicalTypes, - writeDisposition; + timePartitioning, timestampFormat, timestampTargetPrecision, timeZone, + useAvroLogicalTypes, writeDisposition; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -2189,7 +2221,8 @@ @implementation GTLRBigquery_JobConfigurationLoad @"nullMarkers" : [NSString class], @"projectionFields" : [NSString class], @"schemaUpdateOptions" : [NSString class], - @"sourceUris" : [NSString class] + @"sourceUris" : [NSString class], + @"timestampTargetPrecision" : [NSNumber class] }; return map; } @@ -2343,9 +2376,9 @@ @implementation GTLRBigquery_JobStatistics @dynamic completionRatio, copyProperty, creationTime, dataMaskingStatistics, edition, endTime, extract, finalExecutionDurationMs, load, numChildJobs, parentJobId, query, quotaDeferments, reservationId, - reservationUsage, rowLevelSecurityStatistics, scriptStatistics, - sessionInfo, startTime, totalBytesProcessed, totalSlotMs, - transactionInfo; + reservationGroupPath, reservationUsage, rowLevelSecurityStatistics, + scriptStatistics, sessionInfo, startTime, totalBytesProcessed, + totalSlotMs, transactionInfo; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -2358,6 +2391,7 @@ @implementation GTLRBigquery_JobStatistics + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @"quotaDeferments" : [NSString class], + @"reservationGroupPath" : [NSString class], @"reservationUsage" : [GTLRBigquery_JobStatistics_ReservationUsage_Item class] }; return map; @@ -2387,13 +2421,14 @@ @implementation GTLRBigquery_JobStatistics2 ddlDestinationTable, ddlOperationPerformed, ddlTargetDataset, ddlTargetRoutine, ddlTargetRowAccessPolicy, ddlTargetTable, dmlStats, estimatedBytesProcessed, exportDataStatistics, externalServiceCosts, - loadQueryStatistics, materializedViewStatistics, - metadataCacheStatistics, mlStatistics, modelTraining, - modelTrainingCurrentIteration, modelTrainingExpectedTotalIteration, - numDmlAffectedRows, performanceInsights, queryInfo, queryPlan, - referencedRoutines, referencedTables, reservationUsage, schema, - searchStatistics, sparkStatistics, statementType, timeline, - totalBytesBilled, totalBytesProcessed, totalBytesProcessedAccuracy, + incrementalResultStats, loadQueryStatistics, + materializedViewStatistics, metadataCacheStatistics, mlStatistics, + modelTraining, modelTrainingCurrentIteration, + modelTrainingExpectedTotalIteration, numDmlAffectedRows, + performanceInsights, queryInfo, queryPlan, referencedRoutines, + referencedTables, reservationUsage, schema, searchStatistics, + sparkStatistics, statementType, timeline, totalBytesBilled, + totalBytesProcessed, totalBytesProcessedAccuracy, totalPartitionsProcessed, totalServicesSkuSlotMs, totalSlotMs, transferredBytes, undeclaredQueryParameters, vectorSearchStatistics; @@ -3035,6 +3070,17 @@ @implementation GTLRBigquery_ProjectReference @end +// ---------------------------------------------------------------------------- +// +// GTLRBigquery_PruningStats +// + +@implementation GTLRBigquery_PruningStats +@dynamic postCmetaPruningParallelInputCount, postCmetaPruningPartitionCount, + preCmetaPruningParallelInputCount; +@end + + // ---------------------------------------------------------------------------- // // GTLRBigquery_PythonOptions @@ -3466,10 +3512,11 @@ @implementation GTLRBigquery_ScriptStatistics // @implementation GTLRBigquery_SearchStatistics -@dynamic indexUnusedReasons, indexUsageMode; +@dynamic indexPruningStats, indexUnusedReasons, indexUsageMode; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"indexPruningStats" : [GTLRBigquery_IndexPruningStats class], @"indexUnusedReasons" : [GTLRBigquery_IndexUnusedReason class] }; return map; @@ -4059,7 +4106,7 @@ @implementation GTLRBigquery_TableFieldSchema @dynamic categories, collation, dataPolicies, defaultValueExpression, descriptionProperty, fields, foreignTypeDefinition, maxLength, mode, name, policyTags, precision, rangeElementType, roundingMode, scale, - type; + timestampPrecision, type; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"descriptionProperty" : @"description" }; @@ -4201,7 +4248,8 @@ @implementation GTLRBigquery_TableList_Tables_Item_View // @implementation GTLRBigquery_TableMetadataCacheUsage -@dynamic explanation, staleness, tableReference, tableType, unusedReason; +@dynamic explanation, pruningStats, staleness, tableReference, tableType, + unusedReason; @end @@ -4321,25 +4369,28 @@ @implementation GTLRBigquery_TrainingOptions colsampleBytree, contributionMetric, dartNormalizeType, dataFrequency, dataSplitColumn, dataSplitEvalFraction, dataSplitMethod, decomposeTimeSeries, dimensionIdColumns, distanceType, dropout, - earlyStop, enableGlobalExplain, feedbackType, fitIntercept, - forecastLimitLowerBound, forecastLimitUpperBound, hiddenUnits, - holidayRegion, holidayRegions, horizon, hparamTuningObjectives, - includeDrift, initialLearnRate, inputLabelColumns, - instanceWeightColumn, integratedGradientsNumSteps, isTestColumn, - itemColumn, kmeansInitializationColumn, kmeansInitializationMethod, + earlyStop, enableGlobalExplain, endpointIdleTtl, feedbackType, + fitIntercept, forecastLimitLowerBound, forecastLimitUpperBound, + hiddenUnits, holidayRegion, holidayRegions, horizon, + hparamTuningObjectives, huggingFaceModelId, includeDrift, + initialLearnRate, inputLabelColumns, instanceWeightColumn, + integratedGradientsNumSteps, isTestColumn, itemColumn, + kmeansInitializationColumn, kmeansInitializationMethod, l1RegActivation, l1Regularization, l2Regularization, labelClassWeights, - learnRate, learnRateStrategy, lossType, maxIterations, - maxParallelTrials, maxTimeSeriesLength, maxTreeDepth, - minAprioriSupport, minRelativeProgress, minSplitLoss, - minTimeSeriesLength, minTreeChildWeight, modelRegistry, modelUri, - nonSeasonalOrder, numClusters, numFactors, numParallelTree, - numPrincipalComponents, numTrials, optimizationStrategy, optimizer, - pcaExplainedVarianceRatio, pcaSolver, sampledShapleyNumPaths, - scaleFeatures, standardizeFeatures, subsample, tfVersion, - timeSeriesDataColumn, timeSeriesIdColumn, timeSeriesIdColumns, - timeSeriesLengthFraction, timeSeriesTimestampColumn, treeMethod, - trendSmoothingWindowSize, userColumn, vertexAiModelVersionAliases, - walsAlpha, warmStart, xgboostVersion; + learnRate, learnRateStrategy, lossType, machineType, maxIterations, + maxParallelTrials, maxReplicaCount, maxTimeSeriesLength, maxTreeDepth, + minAprioriSupport, minRelativeProgress, minReplicaCount, minSplitLoss, + minTimeSeriesLength, minTreeChildWeight, modelGardenModelName, + modelRegistry, modelUri, nonSeasonalOrder, numClusters, numFactors, + numParallelTree, numPrincipalComponents, numTrials, + optimizationStrategy, optimizer, pcaExplainedVarianceRatio, pcaSolver, + reservationAffinityKey, reservationAffinityType, + reservationAffinityValues, sampledShapleyNumPaths, scaleFeatures, + standardizeFeatures, subsample, tfVersion, timeSeriesDataColumn, + timeSeriesIdColumn, timeSeriesIdColumns, timeSeriesLengthFraction, + timeSeriesTimestampColumn, treeMethod, trendSmoothingWindowSize, + userColumn, vertexAiModelVersionAliases, walsAlpha, warmStart, + xgboostVersion; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -4348,6 +4399,7 @@ @implementation GTLRBigquery_TrainingOptions @"holidayRegions" : [NSString class], @"hparamTuningObjectives" : [NSString class], @"inputLabelColumns" : [NSString class], + @"reservationAffinityValues" : [NSString class], @"timeSeriesIdColumns" : [NSString class], @"vertexAiModelVersionAliases" : [NSString class] }; diff --git a/Sources/GeneratedServices/Bigquery/Public/GoogleAPIClientForREST/GTLRBigqueryObjects.h b/Sources/GeneratedServices/Bigquery/Public/GoogleAPIClientForREST/GTLRBigqueryObjects.h index f37017232..5c37763b0 100644 --- a/Sources/GeneratedServices/Bigquery/Public/GoogleAPIClientForREST/GTLRBigqueryObjects.h +++ b/Sources/GeneratedServices/Bigquery/Public/GoogleAPIClientForREST/GTLRBigqueryObjects.h @@ -96,6 +96,8 @@ @class GTLRBigquery_HivePartitioningOptions; @class GTLRBigquery_HparamSearchSpaces; @class GTLRBigquery_HparamTuningTrial; +@class GTLRBigquery_IncrementalResultStats; +@class GTLRBigquery_IndexPruningStats; @class GTLRBigquery_IndexUnusedReason; @class GTLRBigquery_InputDataChange; @class GTLRBigquery_IntArray; @@ -153,6 +155,7 @@ @class GTLRBigquery_PrivacyPolicy; @class GTLRBigquery_ProjectList_Projects_Item; @class GTLRBigquery_ProjectReference; +@class GTLRBigquery_PruningStats; @class GTLRBigquery_PythonOptions; @class GTLRBigquery_QueryInfo; @class GTLRBigquery_QueryInfo_OptimizationDetails; @@ -973,6 +976,22 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_HparamTuningTrial_Status_Succee */ FOUNDATION_EXTERN NSString * const kGTLRBigquery_HparamTuningTrial_Status_TrialStatusUnspecified; +// ---------------------------------------------------------------------------- +// GTLRBigquery_IncrementalResultStats.disabledReason + +/** + * Disabled reason not specified. + * + * Value: "DISABLED_REASON_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBigquery_IncrementalResultStats_DisabledReason_DisabledReasonUnspecified; +/** + * Some other reason. + * + * Value: "OTHER" + */ +FOUNDATION_EXTERN NSString * const kGTLRBigquery_IncrementalResultStats_DisabledReason_Other; + // ---------------------------------------------------------------------------- // GTLRBigquery_IndexUnusedReason.code @@ -3796,6 +3815,34 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_TrainingOptions_PcaSolver_Rando */ FOUNDATION_EXTERN NSString * const kGTLRBigquery_TrainingOptions_PcaSolver_Unspecified; +// ---------------------------------------------------------------------------- +// GTLRBigquery_TrainingOptions.reservationAffinityType + +/** + * Any reservation. + * + * Value: "ANY_RESERVATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_AnyReservation; +/** + * No reservation. + * + * Value: "NO_RESERVATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_NoReservation; +/** + * Default value. + * + * Value: "RESERVATION_AFFINITY_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_ReservationAffinityTypeUnspecified; +/** + * Specific reservation. + * + * Value: "SPECIFIC_RESERVATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRBigquery_TrainingOptions_ReservationAffinityType_SpecificReservation; + // ---------------------------------------------------------------------------- // GTLRBigquery_TrainingOptions.treeMethod @@ -6970,6 +7017,22 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, copy, nullable) NSString *timestampFormat; +/** + * Precisions (maximum number of total digits in base 10) for seconds of + * TIMESTAMP types that are allowed to the destination table for autodetection + * mode. Available for the formats: CSV. For the CSV Format, Possible values + * include: Not Specified, [], or [6]: timestamp(6) for all auto detected + * TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP + * columns that have less than 6 digits of subseconds. timestamp(12) for all + * auto detected TIMESTAMP columns that have more than 6 digits of subseconds. + * [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of + * the elements in this array is ignored. Inputs that have higher precision + * than the highest target precision in this array will be truncated. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSArray *timestampTargetPrecision; + /** * Optional. Time zone used when parsing timestamp values that do not have * specific time zone information (e.g. 2024-04-20 12:34:56). The expected @@ -7058,9 +7121,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @interface GTLRBigquery_ExternalServiceCost : GTLRObject /** - * The billing method used for the external job. This field is only used when - * billed on the services sku, set to "SERVICES_SKU". Otherwise, it is - * unspecified for backward compatibility. + * The billing method used for the external job. This field, set to + * `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, + * it is unspecified for backward compatibility. */ @property(nonatomic, copy, nullable) NSString *billingMethod; @@ -7625,6 +7688,63 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @end +/** + * Statistics related to Incremental Query Results. Populated as part of + * JobStatistics2. This feature is not yet available. + */ +@interface GTLRBigquery_IncrementalResultStats : GTLRObject + +/** + * Reason why incremental query results are/were not written by the query. + * + * Likely values: + * @arg @c kGTLRBigquery_IncrementalResultStats_DisabledReason_DisabledReasonUnspecified + * Disabled reason not specified. (Value: "DISABLED_REASON_UNSPECIFIED") + * @arg @c kGTLRBigquery_IncrementalResultStats_DisabledReason_Other Some + * other reason. (Value: "OTHER") + */ +@property(nonatomic, copy, nullable) NSString *disabledReason; + +/** + * The time at which the result table's contents were modified. May be absent + * if no results have been written or the query has completed. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *resultSetLastModifyTime; + +/** + * The time at which the result table's contents were completely replaced. May + * be absent if no results have been written or the query has completed. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *resultSetLastReplaceTime; + +@end + + +/** + * Statistics for index pruning. + */ +@interface GTLRBigquery_IndexPruningStats : GTLRObject + +/** The base table reference. */ +@property(nonatomic, strong, nullable) GTLRBigquery_TableReference *baseTable; + +/** + * The number of parallel inputs after index pruning. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *postIndexPruningParallelInputCount; + +/** + * The number of parallel inputs before index pruning. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *preIndexPruningParallelInputCount; + +@end + + /** * Reason about why no search index was used in the search query (or * sub-query). @@ -7972,11 +8092,11 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @property(nonatomic, strong, nullable) GTLRBigquery_JobConfigurationExtract *extract; /** - * Optional. Job timeout in milliseconds. If this time limit is exceeded, - * BigQuery will attempt to stop a longer job, but may not always succeed in - * canceling it before the job completes. For example, a job that takes more - * than 60 seconds to complete has a better chance of being stopped than a job - * that takes 10 seconds to complete. + * Optional. Job timeout in milliseconds relative to the job creation time. If + * this time limit is exceeded, BigQuery attempts to stop the job, but might + * not always succeed in canceling it before the job completes. For example, a + * job that takes more than 60 seconds to complete has a better chance of being + * stopped than a job that takes 10 seconds to complete. * * Uses NSNumber of longLongValue. */ @@ -8002,9 +8122,12 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @property(nonatomic, strong, nullable) GTLRBigquery_JobConfigurationLoad *load; /** - * Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to - * allow for this job. If set, the number of slots used to execute the job will - * be throttled to try and keep its slot consumption below the requested rate. + * Optional. A target limit on the rate of slot consumption by this job. If set + * to a value > 0, BigQuery will attempt to limit the rate of slot consumption + * by this job to keep it below the configured limit, even if the job is + * eligible for more slots based on fair scheduling. The unused slots will be + * available for other jobs and queries to use. Note: This feature is not yet + * generally available. * * Uses NSNumber of intValue. */ @@ -8444,9 +8567,10 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa /** * Allows the schema of the destination table to be updated as a side effect of * the load job if a schema is autodetected or supplied in the job - * configuration. Schema update options are supported in two cases: when - * writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE - * and the destination table is a partition of a table, specified by partition + * configuration. Schema update options are supported in three cases: when + * writeDisposition is WRITE_APPEND; when writeDisposition is + * WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the + * destination table is a partition of a table, specified by partition * decorators. For normal tables, WRITE_TRUNCATE will always overwrite the * schema. One or more of the following values are specified: * * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * @@ -8526,6 +8650,22 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa /** Optional. Date format used for parsing TIMESTAMP values. */ @property(nonatomic, copy, nullable) NSString *timestampFormat; +/** + * Precisions (maximum number of total digits in base 10) for seconds of + * TIMESTAMP types that are allowed to the destination table for autodetection + * mode. Available for the formats: CSV. For the CSV Format, Possible values + * include: Not Specified, [], or [6]: timestamp(6) for all auto detected + * TIMESTAMP columns [6, 12]: timestamp(6) for all auto detected TIMESTAMP + * columns that have less than 6 digits of subseconds. timestamp(12) for all + * auto detected TIMESTAMP columns that have more than 6 digits of subseconds. + * [12]: timestamp(12) for all auto detected TIMESTAMP columns. The order of + * the elements in this array is ignored. Inputs that have higher precision + * than the highest target precision in this array will be truncated. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSArray *timestampTargetPrecision; + /** * Optional. Default time zone that will apply when parsing timestamp values * that have no specific time zone. @@ -8703,9 +8843,10 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa /** * Allows the schema of the destination table to be updated as a side effect of - * the query job. Schema update options are supported in two cases: when - * writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE - * and the destination table is a partition of a table, specified by partition + * the query job. Schema update options are supported in three cases: when + * writeDisposition is WRITE_APPEND; when writeDisposition is + * WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the + * destination table is a partition of a table, specified by partition * decorators. For normal tables, WRITE_TRUNCATE will always overwrite the * schema. One or more of the following values are specified: * * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * @@ -9124,6 +9265,15 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, copy, nullable) NSString *reservationId; +/** + * Output only. The reservation group path of the reservation assigned to this + * job. This field has a limit of 10 nested reservation groups. This is to + * maintain consistency between reservatins info schema and jobs info schema. + * The first reservation group is the root reservation group and the last is + * the leaf or lowest level reservation group. + */ +@property(nonatomic, strong, nullable) NSArray *reservationGroupPath; + /** * Output only. Job resource usage breakdown by reservation. This field * reported misleading information and will no longer be populated. @@ -9303,6 +9453,12 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, strong, nullable) NSArray *externalServiceCosts; +/** + * Output only. Statistics related to incremental query results, if enabled for + * the query. This feature is not yet available. + */ +@property(nonatomic, strong, nullable) GTLRBigquery_IncrementalResultStats *incrementalResultStats; + /** Output only. Statistics for a LOAD query. */ @property(nonatomic, strong, nullable) GTLRBigquery_LoadQueryStatistics *loadQueryStatistics; @@ -9503,10 +9659,10 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @property(nonatomic, strong, nullable) NSNumber *totalPartitionsProcessed; /** - * Output only. Total slot-milliseconds for the job that run on external - * services and billed on the service SKU. This field is only populated for + * Output only. Total slot milliseconds for the job that ran on external + * services and billed on the services SKU. This field is only populated for * jobs that have external service costs, and is the total of the usage for - * costs whose billing method is "SERVICES_SKU". + * costs whose billing method is `"SERVICES_SKU"`. * * Uses NSNumber of longLongValue. */ @@ -10900,6 +11056,35 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @end +/** + * The column metadata index pruning statistics. + */ +@interface GTLRBigquery_PruningStats : GTLRObject + +/** + * The number of parallel inputs matched. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *postCmetaPruningParallelInputCount; + +/** + * The number of partitions matched. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *postCmetaPruningPartitionCount; + +/** + * The number of parallel inputs scanned. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *preCmetaPruningParallelInputCount; + +@end + + /** * Options for a user-defined Python function. */ @@ -11175,10 +11360,12 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa @property(nonatomic, strong, nullable) NSNumber *maxResults; /** - * Optional. INTERNAL: DO NOT USE. The maximum rate of slot consumption to - * allow for this job. If set, the number of slots used to execute the job will - * be throttled to try and keep its slot consumption below the requested rate. - * This limit is best effort. + * Optional. A target limit on the rate of slot consumption by this query. If + * set to a value > 0, BigQuery will attempt to limit the rate of slot + * consumption by this query to keep it below the configured limit, even if the + * query is eligible for more slots based on fair scheduling. The unused slots + * will be available for other jobs and queries to use. Note: This feature is + * not yet generally available. * * Uses NSNumber of intValue. */ @@ -12287,6 +12474,14 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @interface GTLRBigquery_SearchStatistics : GTLRObject +/** + * Search index pruning statistics, one for each base table that has a search + * index. If a base table does not have a search index or the index does not + * help with pruning on the base table, then there is no pruning statistics for + * that table. + */ +@property(nonatomic, strong, nullable) NSArray *indexPruningStats; + /** * When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains * why indexes were not used in all or part of the search query. If @@ -13706,6 +13901,16 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, strong, nullable) NSNumber *scale; +/** + * Optional. Precision (maximum number of total digits in base 10) for seconds + * of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type + * with microsecond precision) * 12 (For TIMESTAMP type with picosecond + * precision) + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *timestampPrecision; + /** * Required. The field data type. Possible values include: * STRING * BYTES * * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * @@ -13908,6 +14113,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, copy, nullable) NSString *explanation; +/** The column metadata index pruning statistics. */ +@property(nonatomic, strong, nullable) GTLRBigquery_PruningStats *pruningStats; + /** * Duration since last refresh as of this job for managed tables (indicates * metadata cache staleness as seen by this job). @@ -14407,6 +14615,12 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, strong, nullable) NSNumber *enableGlobalExplain; +/** + * The idle TTL of the endpoint before the resources get destroyed. The default + * value is 6.5 hours. + */ +@property(nonatomic, strong, nullable) GTLRDuration *endpointIdleTtl; + /** * Feedback type that specifies which algorithm to run for matrix * factorization. @@ -14604,6 +14818,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa /** The target evaluation metrics to optimize the hyperparameters for. */ @property(nonatomic, strong, nullable) NSArray *hparamTuningObjectives; +/** The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. */ +@property(nonatomic, copy, nullable) NSString *huggingFaceModelId; + /** * Include drift when fitting an ARIMA model. * @@ -14726,6 +14943,9 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, copy, nullable) NSString *lossType; +/** The type of the machine used to deploy and serve the model. */ +@property(nonatomic, copy, nullable) NSString *machineType; + /** * The maximum number of iterations in training. Used only for iterative * training algorithms. @@ -14741,6 +14961,14 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, strong, nullable) NSNumber *maxParallelTrials; +/** + * The maximum number of machine replicas that will be deployed on an endpoint. + * The default value is equal to min_replica_count. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxReplicaCount; + /** * The maximum number of time points in a time series that can be used in * modeling the trend component of the time series. Don't use this option with @@ -14772,6 +15000,15 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, strong, nullable) NSNumber *minRelativeProgress; +/** + * The minimum number of machine replicas that will be always deployed on an + * endpoint. This value must be greater than or equal to 1. The default value + * is 1. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *minReplicaCount; + /** * Minimum split loss for boosted tree models. * @@ -14800,6 +15037,12 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, strong, nullable) NSNumber *minTreeChildWeight; +/** + * The name of a Vertex model garden publisher model. Format is + * `publishers/{publisher}/models/{model}\@{optional_version_id}`. + */ +@property(nonatomic, copy, nullable) NSString *modelGardenModelName; + /** * The model registry. * @@ -14901,6 +15144,36 @@ FOUNDATION_EXTERN NSString * const kGTLRBigquery_VectorSearchStatistics_IndexUsa */ @property(nonatomic, copy, nullable) NSString *pcaSolver; +/** + * Corresponds to the label key of a reservation resource used by Vertex AI. To + * target a SPECIFIC_RESERVATION by name, use + * `compute.googleapis.com/reservation-name` as the key and specify the name of + * your reservation as its value. + */ +@property(nonatomic, copy, nullable) NSString *reservationAffinityKey; + +/** + * Specifies the reservation affinity type used to configure a Vertex AI + * resource. The default value is `NO_RESERVATION`. + * + * Likely values: + * @arg @c kGTLRBigquery_TrainingOptions_ReservationAffinityType_AnyReservation + * Any reservation. (Value: "ANY_RESERVATION") + * @arg @c kGTLRBigquery_TrainingOptions_ReservationAffinityType_NoReservation + * No reservation. (Value: "NO_RESERVATION") + * @arg @c kGTLRBigquery_TrainingOptions_ReservationAffinityType_ReservationAffinityTypeUnspecified + * Default value. (Value: "RESERVATION_AFFINITY_TYPE_UNSPECIFIED") + * @arg @c kGTLRBigquery_TrainingOptions_ReservationAffinityType_SpecificReservation + * Specific reservation. (Value: "SPECIFIC_RESERVATION") + */ +@property(nonatomic, copy, nullable) NSString *reservationAffinityType; + +/** + * Corresponds to the label values of a reservation resource used by Vertex AI. + * This must be the full resource name of the reservation or reservation block. + */ +@property(nonatomic, strong, nullable) NSArray *reservationAffinityValues; + /** * Number of paths for the sampled Shapley explain method. * diff --git a/Sources/GeneratedServices/BigtableAdmin/GTLRBigtableAdminObjects.m b/Sources/GeneratedServices/BigtableAdmin/GTLRBigtableAdminObjects.m index 17de7c71a..7572a68c0 100644 --- a/Sources/GeneratedServices/BigtableAdmin/GTLRBigtableAdminObjects.m +++ b/Sources/GeneratedServices/BigtableAdmin/GTLRBigtableAdminObjects.m @@ -394,7 +394,7 @@ @implementation GTLRBigtableAdmin_CreateAuthorizedViewRequest // @implementation GTLRBigtableAdmin_CreateBackupMetadata -@dynamic endTime, name, sourceTable, startTime; +@dynamic endTime, finishTime, name, requestTime, sourceTable, startTime; @end @@ -472,7 +472,7 @@ + (Class)classForAdditionalProperties { // @implementation GTLRBigtableAdmin_CreateLogicalViewMetadata -@dynamic endTime, originalRequest, startTime; +@dynamic endTime, finishTime, originalRequest, requestTime, startTime; @end @@ -492,7 +492,7 @@ @implementation GTLRBigtableAdmin_CreateLogicalViewRequest // @implementation GTLRBigtableAdmin_CreateMaterializedViewMetadata -@dynamic endTime, originalRequest, startTime; +@dynamic endTime, finishTime, originalRequest, requestTime, startTime; @end @@ -512,7 +512,7 @@ @implementation GTLRBigtableAdmin_CreateMaterializedViewRequest // @implementation GTLRBigtableAdmin_CreateSchemaBundleMetadata -@dynamic endTime, name, startTime; +@dynamic finishTime, name, requestTime; @end @@ -1873,7 +1873,7 @@ @implementation GTLRBigtableAdmin_Type // @implementation GTLRBigtableAdmin_UndeleteTableMetadata -@dynamic endTime, name, startTime; +@dynamic endTime, finishTime, name, requestTime, startTime; @end @@ -1959,7 +1959,7 @@ @implementation GTLRBigtableAdmin_UpdateInstanceMetadata // @implementation GTLRBigtableAdmin_UpdateLogicalViewMetadata -@dynamic endTime, originalRequest, startTime; +@dynamic endTime, finishTime, originalRequest, requestTime, startTime; @end @@ -1979,7 +1979,7 @@ @implementation GTLRBigtableAdmin_UpdateLogicalViewRequest // @implementation GTLRBigtableAdmin_UpdateSchemaBundleMetadata -@dynamic endTime, name, startTime; +@dynamic finishTime, name, requestTime; @end @@ -1989,7 +1989,7 @@ @implementation GTLRBigtableAdmin_UpdateSchemaBundleMetadata // @implementation GTLRBigtableAdmin_UpdateTableMetadata -@dynamic endTime, name, startTime; +@dynamic endTime, finishTime, name, requestTime, startTime; @end #pragma clang diagnostic pop diff --git a/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminObjects.h b/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminObjects.h index 072566638..e4636d6f5 100644 --- a/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminObjects.h +++ b/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminObjects.h @@ -1432,17 +1432,29 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @interface GTLRBigtableAdmin_CreateBackupMetadata : GTLRObject -/** If set, the time at which this operation finished or was cancelled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** + * If set, the time at which this operation finished or was cancelled. + * DEPRECATED: Use finish_time instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime GTLR_DEPRECATED; + +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** The name of the backup being created. */ @property(nonatomic, copy, nullable) NSString *name; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; + /** The name of the table the backup is created from. */ @property(nonatomic, copy, nullable) NSString *sourceTable; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** + * The time at which this operation started. DEPRECATED: Use request_time + * instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime GTLR_DEPRECATED; @end @@ -1592,8 +1604,11 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @interface GTLRBigtableAdmin_CreateLogicalViewMetadata : GTLRObject -/** If set, the time at which this operation finished or was canceled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** DEPRECATED: Use finish_time instead. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime GTLR_DEPRECATED; + +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** * The request that prompted the initiation of this CreateLogicalView @@ -1601,8 +1616,11 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @property(nonatomic, strong, nullable) GTLRBigtableAdmin_CreateLogicalViewRequest *originalRequest; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; + +/** DEPRECATED: Use request_time instead. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime GTLR_DEPRECATED; @end @@ -1635,8 +1653,14 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @interface GTLRBigtableAdmin_CreateMaterializedViewMetadata : GTLRObject -/** If set, the time at which this operation finished or was canceled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** + * If set, the time at which this operation finished or was canceled. + * DEPRECATED: Use finish_time instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime GTLR_DEPRECATED; + +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** * The request that prompted the initiation of this CreateMaterializedView @@ -1644,8 +1668,14 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @property(nonatomic, strong, nullable) GTLRBigtableAdmin_CreateMaterializedViewRequest *originalRequest; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; + +/** + * The time at which this operation started. DEPRECATED: Use request_time + * instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime GTLR_DEPRECATED; @end @@ -1678,8 +1708,8 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @interface GTLRBigtableAdmin_CreateSchemaBundleMetadata : GTLRObject -/** If set, the time at which this operation finished or was canceled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** * The unique name identifying this schema bundle. Values are of the form @@ -1687,8 +1717,8 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU */ @property(nonatomic, copy, nullable) NSString *name; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; @end @@ -2175,7 +2205,7 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU /** * If set, allows NULL values to be encoded as the empty string "". The actual - * empty string, or any value which only contains the null byte 0x00, has one + * empty string, or any value which only contains the null byte `0x00`, has one * more null byte appended. * * Uses NSNumber of boolValue. @@ -2349,7 +2379,7 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdmin_TableProgress_State_StateU * NULL values to be encoded as the empty string "". The actual empty string, * or any value where every character equals `null_escape_char`, has one more * `null_escape_char` appended. If `null_escape_char` is set and does not equal - * the ASCII null character 0x00, then the encoding will not support sorted + * the ASCII null character `0x00`, then the encoding will not support sorted * mode. . */ @property(nonatomic, copy, nullable) NSString *nullEscapeChar; @@ -2404,9 +2434,9 @@ GTLR_DEPRECATED * single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - * Encoded field values must not contain any bytes <= `delimiter[0]` - * Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == - * B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - - * Fields are encoded in distinct mode. - Encoded field values must not contain - * `delimiter[0]`. + * B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does + * not support `DESC` field ordering. Distinct mode: - Fields are encoded in + * distinct mode. - Encoded field values must not contain `delimiter[0]`. */ @interface GTLRBigtableAdmin_GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes : GTLRObject @@ -2423,25 +2453,33 @@ GTLR_DEPRECATED /** - * Fields are encoded independently and concatenated with the fixed byte pair - * {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is - * replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the - * empty string "" have special handling: - If *every* field encodes to "", or - * if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed - * byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last - * non-empty field, omitting any trailing empty fields. Any empty fields that - * aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - * - STRUCT() -> "\\00\\00" - STRUCT("") -> "\\00\\00" - STRUCT("", "") -> - * "\\00\\00" - STRUCT("", "B") -> "\\00\\00" + "\\00\\01" + "B" - STRUCT("A", - * "") -> "A" - STRUCT("", "B", "") -> "\\00\\00" + "\\00\\01" + "B" - - * STRUCT("A", "", "C") -> "A" + "\\00\\01" + "\\00\\00" + "\\00\\01" + "C" - * Since null bytes are always escaped, this encoding can cause size blowup for - * encodings like `Int64.BigEndianBytes` that are likely to produce many such - * bytes. Sorted mode: - Fields are encoded in sorted mode. - All values - * supported by the field encodings are allowed - Element-wise order is - * preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, - * etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in - * distinct mode. - All values supported by the field encodings are allowed. + * Fields are encoded independently, then escaped and delimited by appling the + * following rules in order: - While the last remaining field is `ASC` or + * `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each + * remaining field, replace all null bytes `0x00` with the fixed byte pair + * `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", + * replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte + * pair `{0x00, 0x01}` to each remaining field, except for the last remaining + * field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the + * results, or emit the fixed byte pair `{0x00, 0x00}` if there are no + * remaining fields to concatenate. Examples: ``` - STRUCT() -> "\\00\\00" - + * STRUCT("") -> "\\00\\00" - STRUCT("", "") -> "\\00\\00" - STRUCT("", "B") -> + * "\\00\\00" + "\\00\\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") + * -> "\\00\\00" + "\\00\\01" + "B" - STRUCT("A", "", "C") -> "A" + "\\00\\01" + * + "\\00\\00" + "\\00\\01" + "C" ``` Examples for struct with `DESC` fields: + * ``` - STRUCT("" DESC) -> "\\xFF\\xFF" + "\\xFF\\xFE" - STRUCT("" DESC, "") + * -> "\\xFF\\xFF" + "\\xFF\\xFE" - STRUCT("" DESC, "", "") -> "\\xFF\\xFF" + + * "\\xFF\\xFE" - STRUCT("" DESC, "A") -> "\\xFF\\xFF" + "\\xFF\\xFE" + "A" - + * STRUCT("A", "" DESC, "") -> "A" + "\\00\\01" + "\\xFF\\xFF" + "\\xFF\\xFE" - + * STRUCT("", "A" DESC) -> "\\x00\\x00" + "\\x00\\x01" + "\\xBE" + "\\xFF\\xFE" + * ``` Since null bytes are always escaped, this encoding can cause size blowup + * for encodings like `Int64.BigEndianBytes` that are likely to produce many + * such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values + * supported by the field encodings are allowed. - Fields with unset or + * `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: + * `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict + * prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - + * All values supported by the field encodings are allowed. */ @interface GTLRBigtableAdmin_GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes : GTLRObject @end @@ -2449,7 +2487,7 @@ GTLR_DEPRECATED /** * Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == - * 1`. + * 1`. This encoding does not support `DESC` field ordering. */ @interface GTLRBigtableAdmin_GoogleBigtableAdminV2TypeStructEncodingSingleton : GTLRObject @end @@ -2808,7 +2846,7 @@ GTLR_DEPRECATED @property(nonatomic, strong, nullable) NSArray *failedLocations; /** DEPRECATED: This field is unused and ignored. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; +@property(nonatomic, copy, nullable) NSString *nextPageToken GTLR_DEPRECATED; @end @@ -2872,7 +2910,7 @@ GTLR_DEPRECATED @property(nonatomic, strong, nullable) NSArray *instances; /** DEPRECATED: This field is unused and ignored. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; +@property(nonatomic, copy, nullable) NSString *nextPageToken GTLR_DEPRECATED; @end @@ -4138,7 +4176,7 @@ GTLR_DEPRECATED * anywhere sort order is important, for example when encoding keys. - * Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) * != Encode(Y)`. However, the converse is not guaranteed. For example, both - * "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid + * `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid * encodings of the same JSON value. The API clearly documents which mode is * used wherever an encoding can be configured. Each encoding also documents * which values are supported in which modes. For example, when encoding INT64 @@ -4198,14 +4236,26 @@ GTLR_DEPRECATED */ @interface GTLRBigtableAdmin_UndeleteTableMetadata : GTLRObject -/** If set, the time at which this operation finished or was cancelled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** + * If set, the time at which this operation finished or was cancelled. + * DEPRECATED: Use finish_time instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime GTLR_DEPRECATED; + +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** The name of the table being restored. */ @property(nonatomic, copy, nullable) NSString *name; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; + +/** + * The time at which this operation started. DEPRECATED: Use request_time + * instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime GTLR_DEPRECATED; @end @@ -4336,8 +4386,11 @@ GTLR_DEPRECATED */ @interface GTLRBigtableAdmin_UpdateLogicalViewMetadata : GTLRObject -/** If set, the time at which this operation finished or was canceled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** DEPRECATED: Use finish_time instead. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime GTLR_DEPRECATED; + +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** * The request that prompted the initiation of this UpdateLogicalView @@ -4345,8 +4398,11 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) GTLRBigtableAdmin_UpdateLogicalViewRequest *originalRequest; -/** The time at which this operation was started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; + +/** DEPRECATED: Use request_time instead. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime GTLR_DEPRECATED; @end @@ -4378,8 +4434,8 @@ GTLR_DEPRECATED */ @interface GTLRBigtableAdmin_UpdateSchemaBundleMetadata : GTLRObject -/** If set, the time at which this operation finished or was canceled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** * The unique name identifying this schema bundle. Values are of the form @@ -4387,8 +4443,8 @@ GTLR_DEPRECATED */ @property(nonatomic, copy, nullable) NSString *name; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; @end @@ -4398,14 +4454,26 @@ GTLR_DEPRECATED */ @interface GTLRBigtableAdmin_UpdateTableMetadata : GTLRObject -/** If set, the time at which this operation finished or was canceled. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** + * If set, the time at which this operation finished or was canceled. + * DEPRECATED: Use finish_time instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime GTLR_DEPRECATED; + +/** The time at which the operation failed or was completed successfully. */ +@property(nonatomic, strong, nullable) GTLRDateTime *finishTime; /** The name of the table being updated. */ @property(nonatomic, copy, nullable) NSString *name; -/** The time at which this operation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** The time at which the original request was received. */ +@property(nonatomic, strong, nullable) GTLRDateTime *requestTime; + +/** + * The time at which this operation started. DEPRECATED: Use request_time + * instead. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime GTLR_DEPRECATED; @end diff --git a/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminQuery.h b/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminQuery.h index 154b70104..f96b83911 100644 --- a/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminQuery.h +++ b/Sources/GeneratedServices/BigtableAdmin/Public/GoogleAPIClientForREST/GTLRBigtableAdminQuery.h @@ -1061,7 +1061,7 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdminViewViewUnspecified; @interface GTLRBigtableAdminQuery_ProjectsInstancesClustersList : GTLRBigtableAdminQuery /** DEPRECATED: This field is unused and ignored. */ -@property(nonatomic, copy, nullable) NSString *pageToken; +@property(nonatomic, copy, nullable) NSString *pageToken GTLR_DEPRECATED; /** * Required. The unique name of the instance for which a list of clusters is @@ -1370,7 +1370,7 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdminViewViewUnspecified; @interface GTLRBigtableAdminQuery_ProjectsInstancesList : GTLRBigtableAdminQuery /** DEPRECATED: This field is unused and ignored. */ -@property(nonatomic, copy, nullable) NSString *pageToken; +@property(nonatomic, copy, nullable) NSString *pageToken GTLR_DEPRECATED; /** * Required. The unique name of the project for which a list of instances is @@ -3702,8 +3702,8 @@ FOUNDATION_EXTERN NSString * const kGTLRBigtableAdminViewViewUnspecified; @interface GTLRBigtableAdminQuery_ProjectsLocationsList : GTLRBigtableAdminQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformObjects.m b/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformObjects.m index 5293007c8..0be55349c 100644 --- a/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformObjects.m +++ b/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformObjects.m @@ -308,11 +308,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCCAIPlatform_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCCAIPlatform_Operation class] + @"operations" : [GTLRCCAIPlatform_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformQuery.m b/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformQuery.m index 508f2f96b..6e59819ee 100644 --- a/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformQuery.m +++ b/Sources/GeneratedServices/CCAIPlatform/GTLRCCAIPlatformQuery.m @@ -237,7 +237,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCCAIPlatformQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformObjects.h b/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformObjects.h index b9023458e..8ae6bfc3e 100644 --- a/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformObjects.h +++ b/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformObjects.h @@ -1005,6 +1005,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCCAIPlatform_WeeklySchedule_Days_Wednesd */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformQuery.h b/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformQuery.h index 8bd2f5a21..2249ea85c 100644 --- a/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformQuery.h +++ b/Sources/GeneratedServices/CCAIPlatform/Public/GoogleAPIClientForREST/GTLRCCAIPlatformQuery.h @@ -284,8 +284,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCCAIPlatformQuery_ProjectsLocationsList : GTLRCCAIPlatformQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -458,6 +458,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCCAIPlatform_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceObjects.m b/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceObjects.m index 29e6b14e8..2dc99c7c2 100644 --- a/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceObjects.m +++ b/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceObjects.m @@ -849,11 +849,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCertificateAuthorityService_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCertificateAuthorityService_Operation class] + @"operations" : [GTLRCertificateAuthorityService_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceQuery.m b/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceQuery.m index 352e87eb8..7aa3ecff5 100644 --- a/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceQuery.m +++ b/Sources/GeneratedServices/CertificateAuthorityService/GTLRCertificateAuthorityServiceQuery.m @@ -1035,7 +1035,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCertificateAuthorityServiceQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceObjects.h b/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceObjects.h index 77c391e4f..a3061d541 100644 --- a/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceObjects.h +++ b/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceObjects.h @@ -2471,6 +2471,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateAuthorityService_RevokedCerti */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceQuery.h b/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceQuery.h index 4f5af6877..c75250184 100644 --- a/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceQuery.h +++ b/Sources/GeneratedServices/CertificateAuthorityService/Public/GoogleAPIClientForREST/GTLRCertificateAuthorityServiceQuery.h @@ -1822,8 +1822,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCertificateAuthorityServiceQuery_ProjectsLocationsList : GTLRCertificateAuthorityServiceQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -1996,6 +1996,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCertificateAuthorityService_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerObjects.m b/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerObjects.m index 757d6c7b2..7aebdf087 100644 --- a/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerObjects.m +++ b/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerObjects.m @@ -59,6 +59,14 @@ NSString * const kGTLRCertificateManager_ProvisioningIssue_Reason_RateLimited = @"RATE_LIMITED"; NSString * const kGTLRCertificateManager_ProvisioningIssue_Reason_ReasonUnspecified = @"REASON_UNSPECIFIED"; +// GTLRCertificateManager_Troubleshooting.issues +NSString * const kGTLRCertificateManager_Troubleshooting_Issues_CertificateNotAttached = @"CERTIFICATE_NOT_ATTACHED"; +NSString * const kGTLRCertificateManager_Troubleshooting_Issues_CnameMismatch = @"CNAME_MISMATCH"; +NSString * const kGTLRCertificateManager_Troubleshooting_Issues_IssueUnspecified = @"ISSUE_UNSPECIFIED"; +NSString * const kGTLRCertificateManager_Troubleshooting_Issues_NoResolvedIps = @"NO_RESOLVED_IPS"; +NSString * const kGTLRCertificateManager_Troubleshooting_Issues_ResolvedToNotServing = @"RESOLVED_TO_NOT_SERVING"; +NSString * const kGTLRCertificateManager_Troubleshooting_Issues_ResolvedToServingOnAltPorts = @"RESOLVED_TO_SERVING_ON_ALT_PORTS"; + // ---------------------------------------------------------------------------- // // GTLRCertificateManager_AllowlistedCertificate @@ -75,7 +83,7 @@ @implementation GTLRCertificateManager_AllowlistedCertificate // @implementation GTLRCertificateManager_AuthorizationAttemptInfo -@dynamic details, domain, failureReason, state; +@dynamic attemptTime, details, domain, failureReason, state, troubleshooting; @end @@ -250,6 +258,24 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRCertificateManager_CNAME +// + +@implementation GTLRCertificateManager_CNAME +@dynamic expectedData, name, resolvedData; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"resolvedData" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCertificateManager_DnsAuthorization @@ -345,6 +371,26 @@ @implementation GTLRCertificateManager_IpConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRCertificateManager_IPs +// + +@implementation GTLRCertificateManager_IPs +@dynamic resolved, serving, servingOnAltPorts; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"resolved" : [NSString class], + @"serving" : [NSString class], + @"servingOnAltPorts" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCertificateManager_ListCertificateIssuanceConfigsResponse @@ -488,11 +534,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCertificateManager_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCertificateManager_Operation class] + @"operations" : [GTLRCertificateManager_Operation class], + @"unreachable" : [NSString class] }; return map; } @@ -687,6 +734,24 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRCertificateManager_Troubleshooting +// + +@implementation GTLRCertificateManager_Troubleshooting +@dynamic cname, ips, issues; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"issues" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCertificateManager_TrustAnchor diff --git a/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerQuery.m b/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerQuery.m index 5c7f7eab9..027d05fbf 100644 --- a/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerQuery.m +++ b/Sources/GeneratedServices/CertificateManager/GTLRCertificateManagerQuery.m @@ -681,7 +681,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCertificateManagerQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerObjects.h b/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerObjects.h index 7a93ede43..7d59c1ab9 100644 --- a/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerObjects.h +++ b/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerObjects.h @@ -24,12 +24,14 @@ @class GTLRCertificateManager_CertificateMap_Labels; @class GTLRCertificateManager_CertificateMapEntry; @class GTLRCertificateManager_CertificateMapEntry_Labels; +@class GTLRCertificateManager_CNAME; @class GTLRCertificateManager_DnsAuthorization; @class GTLRCertificateManager_DnsAuthorization_Labels; @class GTLRCertificateManager_DnsResourceRecord; @class GTLRCertificateManager_GclbTarget; @class GTLRCertificateManager_IntermediateCA; @class GTLRCertificateManager_IpConfig; +@class GTLRCertificateManager_IPs; @class GTLRCertificateManager_Location; @class GTLRCertificateManager_Location_Labels; @class GTLRCertificateManager_Location_Metadata; @@ -41,6 +43,7 @@ @class GTLRCertificateManager_SelfManagedCertificate; @class GTLRCertificateManager_Status; @class GTLRCertificateManager_Status_Details_Item; +@class GTLRCertificateManager_Troubleshooting; @class GTLRCertificateManager_TrustAnchor; @class GTLRCertificateManager_TrustConfig; @class GTLRCertificateManager_TrustConfig_Labels; @@ -295,6 +298,49 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea */ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Reason_ReasonUnspecified; +// ---------------------------------------------------------------------------- +// GTLRCertificateManager_Troubleshooting.issues + +/** + * Certificate is not configured to be served from any IPs (e.g. Certificate is + * not attached to any load balancer). + * + * Value: "CERTIFICATE_NOT_ATTACHED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_Troubleshooting_Issues_CertificateNotAttached; +/** + * The resolved CNAME value doesn't match the expected CNAME. + * + * Value: "CNAME_MISMATCH" + */ +FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_Troubleshooting_Issues_CnameMismatch; +/** + * Issue is unspecified. + * + * Value: "ISSUE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_Troubleshooting_Issues_IssueUnspecified; +/** + * Domain doesn't have any A/AAAA records. + * + * Value: "NO_RESOLVED_IPS" + */ +FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_Troubleshooting_Issues_NoResolvedIps; +/** + * Domain has A/AAAA records that point to IPs, where the certificate is not + * attached. + * + * Value: "RESOLVED_TO_NOT_SERVING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_Troubleshooting_Issues_ResolvedToNotServing; +/** + * Domain has A/AAAA records that point to IPs, where the certificate is + * attached, but port 443 is not open. + * + * Value: "RESOLVED_TO_SERVING_ON_ALT_PORTS" + */ +FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_Troubleshooting_Issues_ResolvedToServingOnAltPorts; + /** * Defines an allowlisted certificate. */ @@ -314,6 +360,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea */ @interface GTLRCertificateManager_AuthorizationAttemptInfo : GTLRObject +/** Output only. The timestamp, when the authorization attempt was made. */ +@property(nonatomic, strong, nullable) GTLRDateTime *attemptTime; + /** * Output only. Human readable explanation for reaching the state. Provided to * help address the configuration issues. Not guaranteed to be stable. For @@ -362,6 +411,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea */ @property(nonatomic, copy, nullable) NSString *state; +/** + * Output only. Troubleshooting information for the authorization attempt. This + * field is only populated if the authorization attempt failed. + */ +@property(nonatomic, strong, nullable) GTLRCertificateManager_Troubleshooting *troubleshooting; + @end @@ -699,6 +754,34 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea @end +/** + * CNAME troubleshooting information. + */ +@interface GTLRCertificateManager_CNAME : GTLRObject + +/** + * Output only. The expected value of the CNAME record for the domain, equals + * to `dns_resource_record.data` in the corresponding `DnsAuthorization`. + */ +@property(nonatomic, copy, nullable) NSString *expectedData; + +/** + * Output only. The name of the CNAME record for the domain, equals to + * `dns_resource_record.name` in the corresponding `DnsAuthorization`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Output only. The resolved CNAME chain. Empty list if the CNAME record for + * `CNAME.name` is not found. Otherwise the first item is the value of the + * CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item + * is the value of the CNAME record for the first item, and so on. + */ +@property(nonatomic, strong, nullable) NSArray *resolvedData; + +@end + + /** * A DnsAuthorization resource describes a way to perform domain authorization * for certificate issuance. @@ -867,6 +950,32 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea @end +/** + * IPs troubleshooting information. + */ +@interface GTLRCertificateManager_IPs : GTLRObject + +/** + * Output only. The list of IP addresses resolved from the domain's A/AAAA + * records. Can contain both ipv4 and ipv6 addresses. + */ +@property(nonatomic, strong, nullable) NSArray *resolved; + +/** + * Output only. The list of IP addresses, where the certificate is attached and + * port 443 is open. + */ +@property(nonatomic, strong, nullable) NSArray *serving; + +/** + * Output only. The list of IP addresses, where the certificate is attached, + * but port 443 is not open. + */ +@property(nonatomic, strong, nullable) NSArray *servingOnAltPorts; + +@end + + /** * Response for the `ListCertificateIssuanceConfigs` method. * @@ -1067,6 +1176,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end @@ -1442,6 +1558,25 @@ FOUNDATION_EXTERN NSString * const kGTLRCertificateManager_ProvisioningIssue_Rea @end +/** + * Troubleshooting information for the authorization attempt. + */ +@interface GTLRCertificateManager_Troubleshooting : GTLRObject + +/** Output only. CNAME troubleshooting information. */ +@property(nonatomic, strong, nullable) GTLRCertificateManager_CNAME *cname; + +/** Output only. IPs troubleshooting information. */ +@property(nonatomic, strong, nullable) GTLRCertificateManager_IPs *ips; + +/** + * Output only. The list of issues discovered during the authorization attempt. + */ +@property(nonatomic, strong, nullable) NSArray *issues; + +@end + + /** * Defines a trust anchor. */ diff --git a/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerQuery.h b/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerQuery.h index d3868e2e2..1e575edd0 100644 --- a/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerQuery.h +++ b/Sources/GeneratedServices/CertificateManager/Public/GoogleAPIClientForREST/GTLRCertificateManagerQuery.h @@ -1066,8 +1066,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCertificateManagerQuery_ProjectsLocationsList : GTLRCertificateManagerQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -1240,6 +1240,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCertificateManager_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/ChecksService/GTLRChecksServiceObjects.m b/Sources/GeneratedServices/ChecksService/GTLRChecksServiceObjects.m index 0792707c3..d1b013a8a 100644 --- a/Sources/GeneratedServices/ChecksService/GTLRChecksServiceObjects.m +++ b/Sources/GeneratedServices/ChecksService/GTLRChecksServiceObjects.m @@ -1192,11 +1192,12 @@ @implementation GTLRChecksService_GoogleChecksRepoScanV1alphaSourceCode // @implementation GTLRChecksService_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRChecksService_Operation class] + @"operations" : [GTLRChecksService_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/ChecksService/GTLRChecksServiceQuery.m b/Sources/GeneratedServices/ChecksService/GTLRChecksServiceQuery.m index 1e7b0cd10..4a3d71460 100644 --- a/Sources/GeneratedServices/ChecksService/GTLRChecksServiceQuery.m +++ b/Sources/GeneratedServices/ChecksService/GTLRChecksServiceQuery.m @@ -122,7 +122,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRChecksServiceQuery_AccountsAppsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceObjects.h b/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceObjects.h index 49ecaa372..00b08ccbf 100644 --- a/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceObjects.h +++ b/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceObjects.h @@ -4526,6 +4526,13 @@ FOUNDATION_EXTERN NSString * const kGTLRChecksService_GoogleChecksRepoScanV1alph */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceQuery.h b/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceQuery.h index 7ff51910b..490d3c2e2 100644 --- a/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceQuery.h +++ b/Sources/GeneratedServices/ChecksService/Public/GoogleAPIClientForREST/GTLRChecksServiceQuery.h @@ -216,6 +216,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRChecksService_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Classroom/Public/GoogleAPIClientForREST/GTLRClassroomObjects.h b/Sources/GeneratedServices/Classroom/Public/GoogleAPIClientForREST/GTLRClassroomObjects.h index 5ed63a26b..ab4304b51 100644 --- a/Sources/GeneratedServices/Classroom/Public/GoogleAPIClientForREST/GTLRClassroomObjects.h +++ b/Sources/GeneratedServices/Classroom/Public/GoogleAPIClientForREST/GTLRClassroomObjects.h @@ -1203,7 +1203,7 @@ FOUNDATION_EXTERN NSString * const kGTLRClassroom_StudentSubmission_State_Turned /** * The gradebook settings that specify how a student's overall grade for the - * course will be calculated and who it will be displayed to. Read-only + * course will be calculated and who it will be displayed to. Read-only. */ @property(nonatomic, strong, nullable) GTLRClassroom_GradebookSettings *gradebookSettings; diff --git a/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminObjects.m b/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminObjects.m index c324aab04..96d887d1c 100644 --- a/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminObjects.m +++ b/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminObjects.m @@ -253,6 +253,7 @@ // GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.feedType NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_BackupdrMetadata = @"BACKUPDR_METADATA"; NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_ConfigBasedSignalData = @"CONFIG_BASED_SIGNAL_DATA"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_DatabaseResourceSignalData = @"DATABASE_RESOURCE_SIGNAL_DATA"; NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_FeedtypeUnspecified = @"FEEDTYPE_UNSPECIFIED"; NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_ObservabilityData = @"OBSERVABILITY_DATA"; NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_RecommendationSignalData = @"RECOMMENDATION_SIGNAL_DATA"; @@ -610,6 +611,23 @@ NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainOperationError_ErrorType_SqlserverError = @"SQLSERVER_ERROR"; NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainOperationError_ErrorType_StockoutError = @"STOCKOUT_ERROR"; +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule.day +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_DayOfWeekUnspecified = @"DAY_OF_WEEK_UNSPECIFIED"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Friday = @"FRIDAY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Monday = @"MONDAY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Saturday = @"SATURDAY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Sunday = @"SUNDAY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Thursday = @"THURSDAY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Tuesday = @"TUESDAY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Wednesday = @"WEDNESDAY"; + +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule.phase +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseAny = @"WINDOW_PHASE_ANY"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseUnspecified = @"WINDOW_PHASE_UNSPECIFIED"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek1 = @"WINDOW_PHASE_WEEK1"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek2 = @"WINDOW_PHASE_WEEK2"; +NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek5 = @"WINDOW_PHASE_WEEK5"; + // GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings.retentionUnit NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings_RetentionUnit_Count = @"COUNT"; NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings_RetentionUnit_Duration = @"DURATION"; @@ -768,6 +786,24 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_AutoScalingConfig +// + +@implementation GTLRCloudAlloyDBAdmin_AutoScalingConfig +@dynamic policy, schedules; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"schedules" : [GTLRCloudAlloyDBAdmin_Schedule class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_Backup @@ -833,6 +869,58 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_BackupDrBackupSource +// + +@implementation GTLRCloudAlloyDBAdmin_BackupDrBackupSource +@dynamic backup; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_BackupDrEnabledWindow +// + +@implementation GTLRCloudAlloyDBAdmin_BackupDrEnabledWindow +@dynamic automatedBackupPreviouslyEnabled, backupPlanAssociation, + continuousBackupPreviouslyEnabled, + continuousBackupPreviouslyEnabledTime, + continuousBackupPreviousRecoveryWindowDays, dataSource, disabledTime, + enabledTime, logRetentionPeriod; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_BackupDrInfo +// + +@implementation GTLRCloudAlloyDBAdmin_BackupDrInfo +@dynamic currentWindow, previousWindows; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"previousWindows" : [GTLRCloudAlloyDBAdmin_BackupDrEnabledWindow class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_BackupDrPitrSource +// + +@implementation GTLRCloudAlloyDBAdmin_BackupDrPitrSource +@dynamic dataSource, pointInTime; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_BackupSource @@ -888,14 +976,15 @@ @implementation GTLRCloudAlloyDBAdmin_CloudSQLBackupRunSource // @implementation GTLRCloudAlloyDBAdmin_Cluster -@dynamic annotations, automatedBackupPolicy, backupSource, - cloudsqlBackupRunSource, clusterType, continuousBackupConfig, - continuousBackupInfo, createTime, databaseVersion, deleteTime, - displayName, encryptionConfig, encryptionInfo, ETag, initialUser, - labels, maintenanceSchedule, maintenanceUpdatePolicy, migrationSource, - name, network, networkConfig, primaryConfig, pscConfig, reconciling, - satisfiesPzs, secondaryConfig, sslConfig, state, subscriptionType, - tags, trialMetadata, uid, updateTime; +@dynamic annotations, automatedBackupPolicy, backupdrBackupSource, backupdrInfo, + backupSource, cloudsqlBackupRunSource, clusterType, + continuousBackupConfig, continuousBackupInfo, createTime, + databaseVersion, deleteTime, displayName, encryptionConfig, + encryptionInfo, ETag, initialUser, labels, maintenanceSchedule, + maintenanceUpdatePolicy, migrationSource, name, network, networkConfig, + primaryConfig, pscConfig, reconciling, satisfiesPzs, secondaryConfig, + sslConfig, state, subscriptionType, tags, trialMetadata, uid, + updateTime; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"ETag" : @"etag" }; @@ -976,6 +1065,30 @@ @implementation GTLRCloudAlloyDBAdmin_ConnectionInfo @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_ConnectionPoolConfig +// + +@implementation GTLRCloudAlloyDBAdmin_ConnectionPoolConfig +@dynamic enabled, flags, poolerCount; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_ConnectionPoolConfig_Flags +// + +@implementation GTLRCloudAlloyDBAdmin_ConnectionPoolConfig_Flags + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_ContinuousBackupConfig @@ -1014,6 +1127,16 @@ @implementation GTLRCloudAlloyDBAdmin_ContinuousBackupSource @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_CpuUtilization +// + +@implementation GTLRCloudAlloyDBAdmin_CpuUtilization +@dynamic utilizationTarget; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_CsvExportOptions @@ -1246,12 +1369,12 @@ @implementation GTLRCloudAlloyDBAdmin_InjectFaultRequest @implementation GTLRCloudAlloyDBAdmin_Instance @dynamic activationPolicy, annotations, availabilityType, - clientConnectionConfig, createTime, databaseFlags, deleteTime, - displayName, ETag, gceZone, instanceType, ipAddress, labels, - machineConfig, name, networkConfig, nodes, observabilityConfig, - outboundPublicIpAddresses, pscInstanceConfig, publicIpAddress, - queryInsightsConfig, readPoolConfig, reconciling, satisfiesPzs, state, - uid, updateTime, writableNode; + clientConnectionConfig, connectionPoolConfig, createTime, + databaseFlags, deleteTime, displayName, ETag, gceZone, instanceType, + ipAddress, labels, machineConfig, name, networkConfig, nodes, + observabilityConfig, outboundPublicIpAddresses, pscInstanceConfig, + publicIpAddress, queryInsightsConfig, readPoolConfig, reconciling, + satisfiesPzs, state, uid, updateTime, writableNode; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"ETag" : @"etag" }; @@ -1424,11 +1547,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCloudAlloyDBAdmin_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudAlloyDBAdmin_Operation class] + @"operations" : [GTLRCloudAlloyDBAdmin_Operation class], + @"unreachable" : [NSString class] }; return map; } @@ -1630,6 +1754,16 @@ @implementation GTLRCloudAlloyDBAdmin_OperationMetadata @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_Policy +// + +@implementation GTLRCloudAlloyDBAdmin_Policy +@dynamic coolDownPeriodSec, cpuUtilization, enabled, maxNodeCount; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_PrimaryConfig @@ -1752,7 +1886,7 @@ @implementation GTLRCloudAlloyDBAdmin_QueryInsightsInstanceConfig // @implementation GTLRCloudAlloyDBAdmin_ReadPoolConfig -@dynamic nodeCount; +@dynamic autoScalingConfig, nodeCount; @end @@ -1790,8 +1924,8 @@ @implementation GTLRCloudAlloyDBAdmin_RestartInstanceRequest // @implementation GTLRCloudAlloyDBAdmin_RestoreClusterRequest -@dynamic backupSource, cluster, clusterId, continuousBackupSource, requestId, - validateOnly; +@dynamic backupdrBackupSource, backupdrPitrSource, backupSource, cluster, + clusterId, continuousBackupSource, requestId, validateOnly; @end @@ -1805,6 +1939,22 @@ @implementation GTLRCloudAlloyDBAdmin_RestoreFromCloudSQLRequest @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_Schedule +// + +@implementation GTLRCloudAlloyDBAdmin_Schedule +@dynamic cronExpression, descriptionProperty, disabled, durationSec, + minNodeCount, name, timeZone; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_SecondaryConfig @@ -1862,23 +2012,13 @@ @implementation GTLRCloudAlloyDBAdmin_StageInfo @end -// ---------------------------------------------------------------------------- -// -// GTLRCloudAlloyDBAdmin_StageSchedule -// - -@implementation GTLRCloudAlloyDBAdmin_StageSchedule -@dynamic actualEndTime, actualStartTime, estimatedEndTime, estimatedStartTime; -@end - - // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_StageStatus // @implementation GTLRCloudAlloyDBAdmin_StageStatus -@dynamic readPoolInstancesUpgrade, schedule, stage, state; +@dynamic readPoolInstancesUpgrade, stage, state; @end @@ -2087,9 +2227,10 @@ @implementation GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatab @dynamic availabilityConfiguration, backupConfiguration, backupdrConfiguration, backupRun, creationTime, currentState, customMetadata, edition, entitlements, expectedState, gcbdrConfiguration, identifier, - instanceType, location, machineConfiguration, primaryResourceId, - primaryResourceLocation, product, resourceContainer, resourceName, - suspensionReason, tagsSet, updationTime, userLabelSet, zoneProperty; + instanceType, location, machineConfiguration, maintenanceInfo, + primaryResourceId, primaryResourceLocation, product, resourceContainer, + resourceName, suspensionReason, tagsSet, updationTime, userLabelSet, + zoneProperty; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -2206,6 +2347,44 @@ @implementation GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainOpera @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule +// + +@implementation GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule +@dynamic endDate, startDate, time; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo +// + +@implementation GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo +@dynamic denyMaintenanceSchedules, maintenanceSchedule, maintenanceVersion; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"denyMaintenanceSchedules" : [GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule +// + +@implementation GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule +@dynamic day, phase, time; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings diff --git a/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminQuery.m b/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminQuery.m index 216aa0004..361c457f8 100644 --- a/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminQuery.m +++ b/Sources/GeneratedServices/CloudAlloyDBAdmin/GTLRCloudAlloyDBAdminQuery.m @@ -957,7 +957,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudAlloyDBAdminQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminObjects.h b/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminObjects.h index 62f194520..dad908524 100644 --- a/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminObjects.h +++ b/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminObjects.h @@ -27,10 +27,15 @@ @class GTLRCloudAlloyDBAdmin_AuthorizedNetwork; @class GTLRCloudAlloyDBAdmin_AutomatedBackupPolicy; @class GTLRCloudAlloyDBAdmin_AutomatedBackupPolicy_Labels; +@class GTLRCloudAlloyDBAdmin_AutoScalingConfig; @class GTLRCloudAlloyDBAdmin_Backup; @class GTLRCloudAlloyDBAdmin_Backup_Annotations; @class GTLRCloudAlloyDBAdmin_Backup_Labels; @class GTLRCloudAlloyDBAdmin_Backup_Tags; +@class GTLRCloudAlloyDBAdmin_BackupDrBackupSource; +@class GTLRCloudAlloyDBAdmin_BackupDrEnabledWindow; +@class GTLRCloudAlloyDBAdmin_BackupDrInfo; +@class GTLRCloudAlloyDBAdmin_BackupDrPitrSource; @class GTLRCloudAlloyDBAdmin_BackupSource; @class GTLRCloudAlloyDBAdmin_ClientConnectionConfig; @class GTLRCloudAlloyDBAdmin_CloudSQLBackupRunSource; @@ -39,9 +44,12 @@ @class GTLRCloudAlloyDBAdmin_Cluster_Labels; @class GTLRCloudAlloyDBAdmin_Cluster_Tags; @class GTLRCloudAlloyDBAdmin_ClusterUpgradeDetails; +@class GTLRCloudAlloyDBAdmin_ConnectionPoolConfig; +@class GTLRCloudAlloyDBAdmin_ConnectionPoolConfig_Flags; @class GTLRCloudAlloyDBAdmin_ContinuousBackupConfig; @class GTLRCloudAlloyDBAdmin_ContinuousBackupInfo; @class GTLRCloudAlloyDBAdmin_ContinuousBackupSource; +@class GTLRCloudAlloyDBAdmin_CpuUtilization; @class GTLRCloudAlloyDBAdmin_CsvExportOptions; @class GTLRCloudAlloyDBAdmin_CsvImportOptions; @class GTLRCloudAlloyDBAdmin_DenyMaintenancePeriod; @@ -71,6 +79,7 @@ @class GTLRCloudAlloyDBAdmin_Operation; @class GTLRCloudAlloyDBAdmin_Operation_Metadata; @class GTLRCloudAlloyDBAdmin_Operation_Response; +@class GTLRCloudAlloyDBAdmin_Policy; @class GTLRCloudAlloyDBAdmin_PrimaryConfig; @class GTLRCloudAlloyDBAdmin_PscAutoConnectionConfig; @class GTLRCloudAlloyDBAdmin_PscConfig; @@ -81,12 +90,12 @@ @class GTLRCloudAlloyDBAdmin_QueryInsightsInstanceConfig; @class GTLRCloudAlloyDBAdmin_ReadPoolConfig; @class GTLRCloudAlloyDBAdmin_ReadPoolInstancesUpgradeStageStatus; +@class GTLRCloudAlloyDBAdmin_Schedule; @class GTLRCloudAlloyDBAdmin_SecondaryConfig; @class GTLRCloudAlloyDBAdmin_SqlExportOptions; @class GTLRCloudAlloyDBAdmin_SqlImportOptions; @class GTLRCloudAlloyDBAdmin_SslConfig; @class GTLRCloudAlloyDBAdmin_StageInfo; -@class GTLRCloudAlloyDBAdmin_StageSchedule; @class GTLRCloudAlloyDBAdmin_StageStatus; @class GTLRCloudAlloyDBAdmin_Stats; @class GTLRCloudAlloyDBAdmin_Status; @@ -112,6 +121,9 @@ @class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainMachineConfiguration; @class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainObservabilityMetricData; @class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainOperationError; +@class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule; +@class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo; +@class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule; @class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings; @class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainTags; @class GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainTags_Tags; @@ -1296,6 +1308,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterP * Value: "CONFIG_BASED_SIGNAL_DATA" */ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_ConfigBasedSignalData; +/** + * Database resource signal data + * + * Value: "DATABASE_RESOURCE_SIGNAL_DATA" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_DatabaseResourceSignalData; /** Value: "FEEDTYPE_UNSPECIFIED" */ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_FeedtypeUnspecified; /** @@ -3366,6 +3384,92 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterP */ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainOperationError_ErrorType_StockoutError; +// ---------------------------------------------------------------------------- +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule.day + +/** + * The day of the week is unspecified. + * + * Value: "DAY_OF_WEEK_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_DayOfWeekUnspecified; +/** + * Friday + * + * Value: "FRIDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Friday; +/** + * Monday + * + * Value: "MONDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Monday; +/** + * Saturday + * + * Value: "SATURDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Saturday; +/** + * Sunday + * + * Value: "SUNDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Sunday; +/** + * Thursday + * + * Value: "THURSDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Thursday; +/** + * Tuesday + * + * Value: "TUESDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Tuesday; +/** + * Wednesday + * + * Value: "WEDNESDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Wednesday; + +// ---------------------------------------------------------------------------- +// GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule.phase + +/** + * Any phase. + * + * Value: "WINDOW_PHASE_ANY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseAny; +/** + * Phase is unspecified. + * + * Value: "WINDOW_PHASE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseUnspecified; +/** + * Week 1. + * + * Value: "WINDOW_PHASE_WEEK1" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek1; +/** + * Week 2. + * + * Value: "WINDOW_PHASE_WEEK2" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek2; +/** + * Week 5. + * + * Value: "WINDOW_PHASE_WEEK5" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek5; + // ---------------------------------------------------------------------------- // GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings.retentionUnit @@ -4079,6 +4183,23 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * Configuration for autoscaling. + */ +@interface GTLRCloudAlloyDBAdmin_AutoScalingConfig : GTLRObject + +/** Policy for the MIG autoscaler. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_Policy *policy; + +/** + * Optional list of schedules for the MIG autoscaler. If not set, no schedules + * are created. + */ +@property(nonatomic, strong, nullable) NSArray *schedules; + +@end + + /** * Message describing Backup object */ @@ -4307,6 +4428,120 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * Message describing a BackupDrBackupSource. + */ +@interface GTLRCloudAlloyDBAdmin_BackupDrBackupSource : GTLRObject + +/** + * Required. The name of the backup resource with the format: * + * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id} + */ +@property(nonatomic, copy, nullable) NSString *backup; + +@end + + +/** + * Information about a single window when BackupDR was enabled for this + * cluster. + */ +@interface GTLRCloudAlloyDBAdmin_BackupDrEnabledWindow : GTLRObject + +/** + * Whether automated backup was previously enabled prior to enabling BackupDR + * protection for this cluster. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *automatedBackupPreviouslyEnabled; + +/** + * The BackupPlanAssociation resource that was used to enable BackupDR + * protection for this cluster. + */ +@property(nonatomic, copy, nullable) NSString *backupPlanAssociation; + +/** + * Whether continuous backup was previously enabled prior to enabling BackupDR + * protection for this cluster. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *continuousBackupPreviouslyEnabled; + +/** + * The time when continuous backup was previously enabled prior to enabling + * BackupDR protection for this cluster. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *continuousBackupPreviouslyEnabledTime; + +/** + * The retention set for the continuous backup that was previously enabled + * prior to enabling BackupDR protection for this cluster. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *continuousBackupPreviousRecoveryWindowDays; + +/** The DataSource resource that represents the cluster in BackupDR. */ +@property(nonatomic, copy, nullable) NSString *dataSource; + +/** + * Time when the BackupDR protection for this cluster was disabled. This field + * will be empty if this BackupDR window is the `current_window`. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *disabledTime; + +/** Time when the BackupDR protection for this cluster was enabled. */ +@property(nonatomic, strong, nullable) GTLRDateTime *enabledTime; + +/** The retention period for logs generated by BackupDR for this cluster. */ +@property(nonatomic, strong, nullable) GTLRDuration *logRetentionPeriod; + +@end + + +/** + * Information about BackupDR protection for this cluster. + */ +@interface GTLRCloudAlloyDBAdmin_BackupDrInfo : GTLRObject + +/** + * The current BackupDR configuration for this cluster. If BackupDR protection + * is not enabled for this cluster, this field will be empty. + */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupDrEnabledWindow *currentWindow; + +/** + * Windows during which BackupDR was enabled for this cluster, along with + * associated configuration for that window. These are used to determine + * points-in-time for which restores can be performed. The windows are ordered + * with the most recent window last. Windows are mutally exclusive. Windows + * which closed more than 1 year ago will be removed from this list. + */ +@property(nonatomic, strong, nullable) NSArray *previousWindows; + +@end + + +/** + * Message describing a BackupDrPitrSource. + */ +@interface GTLRCloudAlloyDBAdmin_BackupDrPitrSource : GTLRObject + +/** + * Required. The name of the backup resource with the format: * + * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id} + */ +@property(nonatomic, copy, nullable) NSString *dataSource; + +/** Required. The point in time to restore to. */ +@property(nonatomic, strong, nullable) GTLRDateTime *pointInTime; + +@end + + /** * Message describing a BackupSource. */ @@ -4433,6 +4668,15 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW */ @property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_AutomatedBackupPolicy *automatedBackupPolicy; +/** Output only. Cluster created from a BackupDR backup. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupDrBackupSource *backupdrBackupSource; + +/** + * Output only. Output only information about BackupDR protection for this + * cluster. + */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupDrInfo *backupdrInfo; + /** Output only. Cluster created from backup. */ @property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupSource *backupSource; @@ -4809,6 +5053,43 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * Configuration for Managed Connection Pool (MCP). + */ +@interface GTLRCloudAlloyDBAdmin_ConnectionPoolConfig : GTLRObject + +/** + * Optional. Whether to enable Managed Connection Pool (MCP). + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enabled; + +/** Optional. Connection Pool flags, as a list of "key": "value" pairs. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_ConnectionPoolConfig_Flags *flags; + +/** + * Output only. The number of running poolers per instance. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *poolerCount; + +@end + + +/** + * Optional. Connection Pool flags, as a list of "key": "value" pairs. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRCloudAlloyDBAdmin_ConnectionPoolConfig_Flags : GTLRObject +@end + + /** * ContinuousBackupConfig describes the continuous backups recovery * configurations of a cluster. @@ -4897,6 +5178,21 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * CPU utilization policy for the autoscaler. + */ +@interface GTLRCloudAlloyDBAdmin_CpuUtilization : GTLRObject + +/** + * Target CPU utilization as a float between 0 and 1. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *utilizationTarget; + +@end + + /** * Options for exporting data in CSV format. */ @@ -5455,6 +5751,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW /** Optional. Client connection specific configurations */ @property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_ClientConnectionConfig *clientConnectionConfig; +/** Optional. The configuration for Managed Connection Pool (MCP). */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_ConnectionPoolConfig *connectionPoolConfig; + /** Output only. Create time stamp */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -5920,6 +6219,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end @@ -6349,6 +6655,41 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * Policy for the autoscaler. + */ +@interface GTLRCloudAlloyDBAdmin_Policy : GTLRObject + +/** + * The period of time in seconds after a new node is created before the + * autoscaler will incorporate its resource usage (e.g. CPU utilization) into + * the autoscaling recommendation algorithm. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *coolDownPeriodSec; + +/** CPU utilization policy for the autoscaler. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_CpuUtilization *cpuUtilization; + +/** + * If true, autoscaling is enabled for the instance. If not set, the default + * value is false. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enabled; + +/** + * Maximum number of nodes for the autoscaler. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxNodeCount; + +@end + + /** * Configuration for the primary cluster. It has the list of clusters that are * replicating from this cluster. This should be set if and only if the cluster @@ -6627,6 +6968,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW */ @interface GTLRCloudAlloyDBAdmin_ReadPoolConfig : GTLRObject +/** + * Autoscaling configuration for the read pool instance. If not set, the read + * pool instance will not be autoscaled. + */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_AutoScalingConfig *autoScalingConfig; + /** * Read capacity, i.e. number of nodes in a read pool instance. * @@ -6691,6 +7038,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW */ @interface GTLRCloudAlloyDBAdmin_RestoreClusterRequest : GTLRObject +/** BackupDR backup source. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupDrBackupSource *backupdrBackupSource; + +/** BackupDR source used for point in time recovery. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupDrPitrSource *backupdrPitrSource; + /** Backup source. */ @property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_BackupSource *backupSource; @@ -6749,6 +7102,58 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * A schedule for the autoscaler. + */ +@interface GTLRCloudAlloyDBAdmin_Schedule : GTLRObject + +/** + * Cron expression for the triggering the schedule. See + * https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions + * for the syntax. + */ +@property(nonatomic, copy, nullable) NSString *cronExpression; + +/** + * Description of the schedule. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** + * If true, the schedule is disabled. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disabled; + +/** + * Duration of the schedule. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *durationSec; + +/** + * Minimum number of nodes in while the schedule is active. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *minNodeCount; + +/** Name of the schedule. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * The location-based IANA time zone for interpreting the schedule's start + * time. If no time zone is provided, UTC is used by default. + */ +@property(nonatomic, copy, nullable) NSString *timeZone; + +@end + + /** * Configuration information for the secondary cluster. This should be set if * and only if the cluster is of type SECONDARY. @@ -6917,32 +7322,6 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end -/** - * Timing information for the stage execution. - */ -@interface GTLRCloudAlloyDBAdmin_StageSchedule : GTLRObject - -/** Actual end time of the stage. Set only if the stage has completed. */ -@property(nonatomic, strong, nullable) GTLRDateTime *actualEndTime; - -/** Actual start time of the stage. Set only if the stage has started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *actualStartTime; - -/** - * When the stage is expected to end. Set only if the stage has not completed - * yet. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *estimatedEndTime; - -/** - * When the stage is expected to start. Set only if the stage has not started - * yet. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *estimatedStartTime; - -@end - - /** * Status of an upgrade stage. */ @@ -6951,9 +7330,6 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW /** Read pool instances upgrade metadata. */ @property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_ReadPoolInstancesUpgradeStageStatus *readPoolInstancesUpgrade; -/** Output only. Timing information for the stage execution. */ -@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_StageSchedule *schedule; - /** * Upgrade stage. * @@ -7334,7 +7710,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW /** * DatabaseResourceFeed is the top level proto to be used to ingest different - * database resource level events into Condor platform. Next ID: 12 + * database resource level events into Condor platform. Next ID: 13 */ @interface GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed : GTLRObject @@ -7364,6 +7740,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW * Database resource metadata from BackupDR (Value: "BACKUPDR_METADATA") * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_ConfigBasedSignalData * Database config based signal data (Value: "CONFIG_BASED_SIGNAL_DATA") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_DatabaseResourceSignalData + * Database resource signal data (Value: "DATABASE_RESOURCE_SIGNAL_DATA") * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_FeedtypeUnspecified * Value "FEEDTYPE_UNSPECIFIED" * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed_FeedType_ObservabilityData @@ -7988,7 +8366,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW /** - * Common model for database resource instance metadata. Next ID: 27 + * Common model for database resource instance metadata. Next ID: 29 */ @interface GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata : GTLRObject @@ -8127,6 +8505,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW /** Machine configuration for this resource. */ @property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainMachineConfiguration *machineConfiguration; +/** Optional. Maintenance info for the resource. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo *maintenanceInfo; + /** * Identifier for this resource's immediate parent/primary resource if the * current resource is a replica or derived form of another Database resource. @@ -8940,6 +9321,110 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdmin_WeeklySchedule_DaysOfW @end +/** + * Deny maintenance period for the database resource. It specifies the time + * range during which the maintenance cannot start. This is configured by the + * customer. + */ +@interface GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule : GTLRObject + +/** Optional. Deny period end date. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_GoogleTypeDate *endDate; + +/** Optional. The start date of the deny maintenance period. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_GoogleTypeDate *startDate; + +/** + * Optional. Time in UTC when the deny period starts on start_date and ends on + * end_date. + */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_GoogleTypeTimeOfDay *time; + +@end + + +/** + * MaintenanceInfo to capture the maintenance details of database resource. + */ +@interface GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo : GTLRObject + +/** Optional. List of Deny maintenance period for the database resource. */ +@property(nonatomic, strong, nullable) NSArray *denyMaintenanceSchedules; + +/** Optional. Maintenance window for the database resource. */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule *maintenanceSchedule; + +/** + * Optional. Current Maintenance version of the database resource. Example: + * "MYSQL_8_0_41.R20250531.01_15" + */ +@property(nonatomic, copy, nullable) NSString *maintenanceVersion; + +@end + + +/** + * Maintenance window for the database resource. It specifies preferred time + * and day of the week and phase in some cases, when the maintenance can start. + * This is configured by the customer. + */ +@interface GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule : GTLRObject + +/** + * Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, + * etc. + * + * Likely values: + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_DayOfWeekUnspecified + * The day of the week is unspecified. (Value: "DAY_OF_WEEK_UNSPECIFIED") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Friday + * Friday (Value: "FRIDAY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Monday + * Monday (Value: "MONDAY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Saturday + * Saturday (Value: "SATURDAY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Sunday + * Sunday (Value: "SUNDAY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Thursday + * Thursday (Value: "THURSDAY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Tuesday + * Tuesday (Value: "TUESDAY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Day_Wednesday + * Wednesday (Value: "WEDNESDAY") + */ +@property(nonatomic, copy, nullable) NSString *day; + +/** + * Optional. Phase of the maintenance window. This is to capture order of + * maintenance. For example, for Cloud SQL resources, this can be used to + * capture if the maintenance window is in Week1, Week2, Week5, etc. Non + * production resources are usually part of early phase. For more details, + * refer to Cloud SQL resources - + * https://cloud.google.com/sql/docs/mysql/maintenance + * + * Likely values: + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseAny + * Any phase. (Value: "WINDOW_PHASE_ANY") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseUnspecified + * Phase is unspecified. (Value: "WINDOW_PHASE_UNSPECIFIED") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek1 + * Week 1. (Value: "WINDOW_PHASE_WEEK1") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek2 + * Week 2. (Value: "WINDOW_PHASE_WEEK2") + * @arg @c kGTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule_Phase_WindowPhaseWeek5 + * Week 5. (Value: "WINDOW_PHASE_WEEK5") + */ +@property(nonatomic, copy, nullable) NSString *phase; + +/** + * Optional. Preferred time to start the maintenance operation on the specified + * day. + */ +@property(nonatomic, strong, nullable) GTLRCloudAlloyDBAdmin_GoogleTypeTimeOfDay *time; + +@end + + /** * GTLRCloudAlloyDBAdmin_StorageDatabasecenterPartnerapiV1mainRetentionSettings */ diff --git a/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminQuery.h b/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminQuery.h index 5de7d3421..e56b16035 100644 --- a/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminQuery.h +++ b/Sources/GeneratedServices/CloudAlloyDBAdmin/Public/GoogleAPIClientForREST/GTLRCloudAlloyDBAdminQuery.h @@ -1922,6 +1922,17 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudAlloyDBAdminViewInstanceViewUnspeci /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudAlloyDBAdmin_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceObjects.m b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceObjects.m index 86fbee1f1..d961bb1db 100644 --- a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceObjects.m +++ b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceObjects.m @@ -44,8 +44,8 @@ // @implementation GTLRCloudCommercePartnerProcurementService_Account -@dynamic approvals, createTime, inputProperties, name, provider, state, - updateTime; +@dynamic approvals, createTime, inputProperties, name, provider, + resellerParentBillingAccount, state, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ diff --git a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceQuery.m b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceQuery.m index ee6bcffc7..da6068a70 100644 --- a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceQuery.m +++ b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/GTLRCloudCommercePartnerProcurementServiceQuery.m @@ -10,6 +10,18 @@ #import +// ---------------------------------------------------------------------------- +// Constants + +// view +NSString * const kGTLRCloudCommercePartnerProcurementServiceViewAccountViewBasic = @"ACCOUNT_VIEW_BASIC"; +NSString * const kGTLRCloudCommercePartnerProcurementServiceViewAccountViewFull = @"ACCOUNT_VIEW_FULL"; +NSString * const kGTLRCloudCommercePartnerProcurementServiceViewAccountViewUnspecified = @"ACCOUNT_VIEW_UNSPECIFIED"; + +// ---------------------------------------------------------------------------- +// Query Classes +// + @implementation GTLRCloudCommercePartnerProcurementServiceQuery @dynamic fields; @@ -45,7 +57,7 @@ + (instancetype)queryWithObject:(GTLRCloudCommercePartnerProcurementService_Appr @implementation GTLRCloudCommercePartnerProcurementServiceQuery_ProvidersAccountsGet -@dynamic name; +@dynamic name, view; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceObjects.h b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceObjects.h index fbdabc8d2..9e099e9fd 100644 --- a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceObjects.h +++ b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceObjects.h @@ -96,16 +96,15 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudCommercePartnerProcurementService_A // GTLRCloudCommercePartnerProcurementService_Entitlement.state /** - * Indicates that the entitlement has been created but has not yet become - * active. The entitlement will remain in this state until it becomes active. - * If the entitlement requires provider approval, a notification is sent to the - * provider for the activation approval. If the provider does not approve, the + * Indicates that the entitlement has been created, but it hasn't yet become + * active. The entitlement remains in this state until it becomes active. If + * the entitlement requires provider approval, a notification is sent to the + * provider for the activation approval. If the provider doesn't approve, the * entitlement is removed. If approved, the entitlement transitions to the - * EntitlementState.ENTITLEMENT_ACTIVE state after a delay, either a generally - * short processing delay or, if applicable, until the scheduled start time of - * the purchased offer. Plan changes are not allowed in this state. Instead, - * customers are expected to cancel the corresponding order and place a new - * order. + * EntitlementState.ENTITLEMENT_ACTIVE state after either a short processing + * delay or, if applicable, at the scheduled start time of the purchased offer. + * Plan changes aren't allowed in this state. Instead, customers are expected + * to cancel the corresponding order and place a new order. * * Value: "ENTITLEMENT_ACTIVATION_REQUESTED" */ @@ -226,6 +225,14 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudCommercePartnerProcurementService_E */ @property(nonatomic, copy, nullable) NSString *provider; +/** + * Output only. The reseller parent billing account of the account's + * corresponding billing account, applicable only when the corresponding + * billing account is a subaccount of a reseller. Included in responses only + * for view: ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id} + */ +@property(nonatomic, copy, nullable) NSString *resellerParentBillingAccount; + /** * Output only. The state of the account. This is used to decide whether the * customer is in good standing with the provider and is able to make @@ -463,72 +470,72 @@ GTLR_DEPRECATED @property(nonatomic, copy, nullable) NSString *name; /** - * Output only. The end time of the new offer. If the offer was has a term - * duration instead of a specified end date, this field is empty. This field is - * populated even if the entitlement isn't active yet. If there's no upcoming - * offer, the field is empty. * If the entitlement is in - * ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or - * ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If - * the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or - * ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated - * with the expected end time of the upcoming offer (in the future) if the - * upcoming offer has a specified end date. Otherwise, this field will be - * empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this - * field will be empty. + * Output only. The end time of the new offer, determined from the offer's + * specified end date. If the offer des not have a specified end date then this + * field is not set. This field is populated even if the entitlement isn't + * active yet. If there's no upcoming offer, the field is empty. * If the + * entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, + * ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is + * empty. * If the entitlement is in the state + * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, + * and the upcoming offer has a specified end date, then this field is + * populated with the expected end time of the upcoming offer, in the future. + * Otherwise, this field is empty. * If the entitlement is in the state + * ENTITLEMENT_CANCELLED, then this field is empty. */ @property(nonatomic, strong, nullable) GTLRDateTime *newOfferEndTime NS_RETURNS_NOT_RETAINED; /** * Output only. The timestamp when the new offer becomes effective. This field * is populated even if the entitlement isn't active yet. If there's no - * upcoming offer, the field is empty. * If the entitlement is in - * ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated - * when the entitlement is not yet approved. But after the entitlement is - * approved, then this field will be populated with effective time of the - * upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE or - * ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * - * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, - * this field will not be populated since the entitlement change is waiting on - * approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state, - * this field will be populated with the expected effective time of the - * upcoming offer (in the future). * If the entitlement is in - * ENTITLEMENT_CANCELLED state, then this field will be empty. + * upcoming offer, the field is empty. * If the entitlement is in the state + * ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the + * entitlement isn't yet approved. After the entitlement is approved, this + * field is populated with the effective time of the upcoming offer. * If the + * entitlement is in the state ENTITLEMENT_ACTIVE or + * ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the + * entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this + * field isn't populated, because the entitlement change is waiting on + * approval. * If the entitlement is in the state + * ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected + * effective time of the upcoming offer, which is in the future. * If the + * entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty. */ @property(nonatomic, strong, nullable) GTLRDateTime *newOfferStartTime NS_RETURNS_NOT_RETAINED; /** - * Output only. The name of the offer the entitlement is switching to upon a - * pending plan change. Only exists if the pending plan change is moving to an - * offer. This field isn't populated for entitlements which aren't active yet. - * Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR + * Output only. Upon a pending plan change, the name of the offer that the + * entitlement is switching to. Only exists if the pending plan change is + * moving to an offer. This field isn't populated for entitlements which aren't + * active yet. Format: + * 'projects/{project}/services/{service}/privateOffers/{offer}' OR * 'projects/{project}/services/{service}/standardOffers/{offer}', depending on * whether the offer is private or public. The {service} in the name is the * listing service of the offer. It could be either the product service that * the offer is referencing, or a generic private offer parent service. We * recommend that you don't build your integration to rely on the meaning of - * this {service} part. * If the entitlement is in + * this {service} part. * If the entitlement is in the state * ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or - * ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If - * the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or - * ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated - * with the upcoming offer. * If the entitlement is in ENTITLEMENT_CANCELLED - * state, then this will be empty. + * ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the + * entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or + * ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the + * upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, + * then this is empty. */ @property(nonatomic, copy, nullable) NSString *newPendingOffer NS_RETURNS_NOT_RETAINED; /** * Output only. The duration of the new offer, in ISO 8601 duration format. - * This field isn't populated for entitlements which aren't active yet, only - * for pending offer changes. If the offer was has a specified end date instead - * of a duration, this field is empty. * If the entitlement is in - * ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or - * ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the - * entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or - * ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated - * with the duration of the upcoming offer, if the upcoming offer is does not - * have a specified end date. Otherwise, this field will be empty. * If the - * entitlement is in ENTITLEMENT_CANCELLED state, then this field will be - * empty. + * This field is populated for pending offer changes. It isn't populated for + * entitlements which aren't active yet. If the offer has a specified end date + * instead of a duration, this field is empty. * If the entitlement is in the + * state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or + * ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement + * is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or + * ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a + * specified end date, then this field is populated with the duration of the + * upcoming offer. Otherwise, this field is empty. * If the entitlement is in + * the state ENTITLEMENT_CANCELLED, then this field is empty. */ @property(nonatomic, copy, nullable) NSString *newPendingOfferDuration NS_RETURNS_NOT_RETAINED; @@ -540,67 +547,69 @@ GTLR_DEPRECATED /** * Output only. The name of the offer that was procured. Field is empty if - * order was not made using an offer. Format: + * order wasn't made using an offer. Format: * 'projects/{project}/services/{service}/privateOffers/{offer}' OR * 'projects/{project}/services/{service}/standardOffers/{offer}', depending on * whether the offer is private or public. The {service} in the name is the * listing service of the offer. It could be either the product service that * the offer is referencing, or a generic private offer parent service. We * recommend that you don't build your integration to rely on the meaning of - * this {service} part. * If the entitlement is in - * ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with - * the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE, + * this {service} part. * If the entitlement is in the state + * ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming + * offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, * ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or - * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated - * with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED - * state, then this field will be populated with the latest offer the order was + * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the + * current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, + * then this field is populated with the latest offer that the order was * associated with. */ @property(nonatomic, copy, nullable) NSString *offer; /** - * Output only. The offer duration of the current offer in ISO 8601 duration - * format. Field is empty if entitlement was not made using an offer. If the - * offer has a specified end date instead of a duration, this field is empty. * - * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this - * field will be populated with the duration of the upcoming offer, if the - * upcoming offer does not have a specified end date. Otherwise, this field - * will be empty. * If the entitlement is in ENTITLEMENT_ACTIVE, + * Output only. The offer duration of the current offer, in ISO 8601 duration + * format. This is empty if the entitlement wasn't made using an offer, or if + * the offer has a specified end date instead of a duration. * If the + * entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the + * upcoming offer doesn't have a specified end date, then this field is + * populated with the duration of the upcoming offer. Otherwise, this field is + * empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, * ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or - * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be - * populated with the duration of the current offer if the current offer is - * does not have a specific end date. Otherwise, this field will be empty. * If - * the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be - * populated with the duration of the latest offer the order was associated - * with if that offer does not have a specific end date. Otherwise, this field - * will be empty. + * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have + * a specified end date, then this field contains the duration of the current + * offer. Otherwise, this field is empty. * If the entitlement is in the state + * ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then + * this field is populated with the duration of the latest offer that the order + * was associated with. Otherwise, this field is empty. */ @property(nonatomic, copy, nullable) NSString *offerDuration; /** - * Output only. End time for the Offer associated with this entitlement. Note - * that this field value can change over time. This occurs naturally even if - * the offer is not changed, due to auto renewal. * If the entitlement is in - * ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not - * yet approved, then this field will be populated with the expected end time - * of the upcoming offer (in the future) if the upcoming offer has a specified - * end date. Otherwise this field will be empty. * If the entitlement is - * approved, then this field will always be populated with the expected end - * time of the upcoming offer (in the future). This means both this field, and - * the offer_duration field, can co-exist. * If the entitlement is in - * ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this - * field will be populated with the actual expected end time of the current - * offer (in the futre). Meaning, this field will be set, regardless of whether - * the offer has a specific end date or a duration. This means both this field, - * and the offer_duration field, can co-exist. * If the entitlement is in - * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE - * state: * If the current offer has already ended and became pure PAYG, then - * this field reflects the ACTUAL end time of the current offer (in the past). - * * Otherwise, then this is the EXPECTED end date of the current offer (in the - * future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this - * field will be populated with the ACTUAL end time of the latest offer the - * order was associated with (in the past). If the entitlement was cancelled - * before any offer started, then this field will be empty. + * Output only. End time for the current term of the Offer associated with this + * entitlement. The value of this field can change naturally over time due to + * auto-renewal, even if the offer isn't changed. * If the entitlement is in + * the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't + * approved yet approved, and the offer has a specified end date, then this + * field is populated with the expected end time of the upcoming offer, in the + * future. Otherwise, this field is empty. * If the entitlement is approved, + * then this field is populated with the expected end time of the upcoming + * offer, in the future. This means that this field and the field + * offer_duration can both exist. * If the entitlement is in the state + * ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is + * populated with the expected end time of the current offer, in the future. + * This field's value is set regardless of whether the offer has a specific end + * date or a duration. This means that this field and the field offer_duration + * can both exist. * If the entitlement is in the state + * ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: + * * If the entitlement's pricing model is usage based and the associated offer + * is a private offer whose term has ended, then this field reflects the ACTUAL + * end time of the entitlement's associated offer (in the past), even though + * the entitlement associated with this private offer does not terminate at the + * end of that private offer's term. * Otherwise, this is the expected end date + * of the current offer, in the future. * If the entitlement is in the state + * ENTITLEMENT_CANCELLED, then this field is populated with the end time, in + * the past, of the latest offer that the order was associated with. If the + * entitlement was cancelled before any offer started, then this field is + * empty. */ @property(nonatomic, strong, nullable) GTLRDateTime *offerEndTime; @@ -645,17 +654,17 @@ GTLR_DEPRECATED * * Likely values: * @arg @c kGTLRCloudCommercePartnerProcurementService_Entitlement_State_EntitlementActivationRequested - * Indicates that the entitlement has been created but has not yet become - * active. The entitlement will remain in this state until it becomes + * Indicates that the entitlement has been created, but it hasn't yet + * become active. The entitlement remains in this state until it becomes * active. If the entitlement requires provider approval, a notification * is sent to the provider for the activation approval. If the provider - * does not approve, the entitlement is removed. If approved, the + * doesn't approve, the entitlement is removed. If approved, the * entitlement transitions to the EntitlementState.ENTITLEMENT_ACTIVE - * state after a delay, either a generally short processing delay or, if - * applicable, until the scheduled start time of the purchased offer. - * Plan changes are not allowed in this state. Instead, customers are - * expected to cancel the corresponding order and place a new order. - * (Value: "ENTITLEMENT_ACTIVATION_REQUESTED") + * state after either a short processing delay or, if applicable, at the + * scheduled start time of the purchased offer. Plan changes aren't + * allowed in this state. Instead, customers are expected to cancel the + * corresponding order and place a new order. (Value: + * "ENTITLEMENT_ACTIVATION_REQUESTED") * @arg @c kGTLRCloudCommercePartnerProcurementService_Entitlement_State_EntitlementActive * Indicates that the entitlement is active. The procured item is now * usable and any associated billing events will start occurring. diff --git a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceQuery.h b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceQuery.h index c21f5dd68..8b771760b 100644 --- a/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceQuery.h +++ b/Sources/GeneratedServices/CloudCommercePartnerProcurementService/Public/GoogleAPIClientForREST/GTLRCloudCommercePartnerProcurementServiceQuery.h @@ -23,6 +23,38 @@ NS_ASSUME_NONNULL_BEGIN +// ---------------------------------------------------------------------------- +// Constants - For some of the query classes' properties below. + +// ---------------------------------------------------------------------------- +// view + +/** + * Include base account information. This is the default view. All fields from + * Account are included except for the reseller_parent_billing_account field. + * + * Value: "ACCOUNT_VIEW_BASIC" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudCommercePartnerProcurementServiceViewAccountViewBasic; +/** + * Includes all available account information, inclusive of the accounts + * reseller_parent_billing_account, if it's a resold account. + * + * Value: "ACCOUNT_VIEW_FULL" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudCommercePartnerProcurementServiceViewAccountViewFull; +/** + * The default / unset value. For `GetAccount`, it defaults to the FULL view. + * For `ListAccounts`, it only supports BASIC view. + * + * Value: "ACCOUNT_VIEW_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudCommercePartnerProcurementServiceViewAccountViewUnspecified; + +// ---------------------------------------------------------------------------- +// Query Classes +// + /** * Parent class for other Cloud Commerce Partner Procurement Service query * classes. @@ -81,6 +113,25 @@ NS_ASSUME_NONNULL_BEGIN /** Required. The name of the account to retrieve. */ @property(nonatomic, copy, nullable) NSString *name; +/** + * Optional. What information to include in the response. + * + * Likely values: + * @arg @c kGTLRCloudCommercePartnerProcurementServiceViewAccountViewUnspecified + * The default / unset value. For `GetAccount`, it defaults to the FULL + * view. For `ListAccounts`, it only supports BASIC view. (Value: + * "ACCOUNT_VIEW_UNSPECIFIED") + * @arg @c kGTLRCloudCommercePartnerProcurementServiceViewAccountViewBasic + * Include base account information. This is the default view. All fields + * from Account are included except for the + * reseller_parent_billing_account field. (Value: "ACCOUNT_VIEW_BASIC") + * @arg @c kGTLRCloudCommercePartnerProcurementServiceViewAccountViewFull + * Includes all available account information, inclusive of the accounts + * reseller_parent_billing_account, if it's a resold account. (Value: + * "ACCOUNT_VIEW_FULL") + */ +@property(nonatomic, copy, nullable) NSString *view; + /** * Fetches a @c GTLRCloudCommercePartnerProcurementService_Account. * diff --git a/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerObjects.m b/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerObjects.m index d80260624..966f54942 100644 --- a/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerObjects.m +++ b/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerObjects.m @@ -43,6 +43,11 @@ NSString * const kGTLRCloudComposer_ComposerWorkloadStatus_State_Succeeded = @"SUCCEEDED"; NSString * const kGTLRCloudComposer_ComposerWorkloadStatus_State_Warning = @"WARNING"; +// GTLRCloudComposer_ConfigConflict.type +NSString * const kGTLRCloudComposer_ConfigConflict_Type_Blocking = @"BLOCKING"; +NSString * const kGTLRCloudComposer_ConfigConflict_Type_ConflictTypeUnspecified = @"CONFLICT_TYPE_UNSPECIFIED"; +NSString * const kGTLRCloudComposer_ConfigConflict_Type_NonBlocking = @"NON_BLOCKING"; + // GTLRCloudComposer_Environment.state NSString * const kGTLRCloudComposer_Environment_State_Creating = @"CREATING"; NSString * const kGTLRCloudComposer_Environment_State_Deleting = @"DELETING"; @@ -136,8 +141,16 @@ @implementation GTLRCloudComposer_CheckUpgradeRequest // @implementation GTLRCloudComposer_CheckUpgradeResponse -@dynamic buildLogUri, containsPypiModulesConflict, imageVersion, - pypiConflictBuildLogExtract, pypiDependencies; +@dynamic buildLogUri, configConflicts, containsPypiModulesConflict, + imageVersion, pypiConflictBuildLogExtract, pypiDependencies; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"configConflicts" : [GTLRCloudComposer_ConfigConflict class] + }; + return map; +} + @end @@ -195,6 +208,16 @@ @implementation GTLRCloudComposer_ComposerWorkloadStatus @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudComposer_ConfigConflict +// + +@implementation GTLRCloudComposer_ConfigConflict +@dynamic message, type; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudComposer_DagProcessorResource @@ -455,11 +478,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCloudComposer_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudComposer_Operation class] + @"operations" : [GTLRCloudComposer_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerQuery.m b/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerQuery.m index 465ff6846..1dc31450a 100644 --- a/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerQuery.m +++ b/Sources/GeneratedServices/CloudComposer/GTLRCloudComposerQuery.m @@ -662,7 +662,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudComposerQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerObjects.h b/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerObjects.h index 6eb25a1a3..b0cb07438 100644 --- a/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerObjects.h +++ b/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerObjects.h @@ -21,6 +21,7 @@ @class GTLRCloudComposer_CloudDataLineageIntegration; @class GTLRCloudComposer_ComposerWorkload; @class GTLRCloudComposer_ComposerWorkloadStatus; +@class GTLRCloudComposer_ConfigConflict; @class GTLRCloudComposer_DagProcessorResource; @class GTLRCloudComposer_DatabaseConfig; @class GTLRCloudComposer_DataRetentionConfig; @@ -222,6 +223,29 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_ComposerWorkloadStatus_Sta */ FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_ComposerWorkloadStatus_State_Warning; +// ---------------------------------------------------------------------------- +// GTLRCloudComposer_ConfigConflict.type + +/** + * Conflict is blocking, the upgrade would fail. + * + * Value: "BLOCKING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_ConfigConflict_Type_Blocking; +/** + * Conflict type is unknown. + * + * Value: "CONFLICT_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_ConfigConflict_Type_ConflictTypeUnspecified; +/** + * Conflict is non-blocking. The upgrade would succeed, but the environment + * configuration would be changed. + * + * Value: "NON_BLOCKING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_ConfigConflict_Type_NonBlocking; + // ---------------------------------------------------------------------------- // GTLRCloudComposer_Environment.state @@ -565,6 +589,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_TaskLogsRetentionConfig_St /** Output only. Url for a docker build log of an upgraded image. */ @property(nonatomic, copy, nullable) NSString *buildLogUri; +/** + * Output only. Contains information about environment configuration that is + * incompatible with the new image version, except for pypi modules conflicts. + */ +@property(nonatomic, strong, nullable) NSArray *configConflicts; + /** * Output only. Whether build has succeeded or failed on modules conflicts. * @@ -717,6 +747,31 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_TaskLogsRetentionConfig_St @end +/** + * Environment configuration conflict. + */ +@interface GTLRCloudComposer_ConfigConflict : GTLRObject + +/** Conflict message. */ +@property(nonatomic, copy, nullable) NSString *message; + +/** + * Conflict type. It can be blocking or non-blocking. + * + * Likely values: + * @arg @c kGTLRCloudComposer_ConfigConflict_Type_Blocking Conflict is + * blocking, the upgrade would fail. (Value: "BLOCKING") + * @arg @c kGTLRCloudComposer_ConfigConflict_Type_ConflictTypeUnspecified + * Conflict type is unknown. (Value: "CONFLICT_TYPE_UNSPECIFIED") + * @arg @c kGTLRCloudComposer_ConfigConflict_Type_NonBlocking Conflict is + * non-blocking. The upgrade would succeed, but the environment + * configuration would be changed. (Value: "NON_BLOCKING") + */ +@property(nonatomic, copy, nullable) NSString *type; + +@end + + /** * Configuration for resources used by Airflow DAG processors. This field is * supported for Cloud Composer environments in versions @@ -1419,6 +1474,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudComposer_TaskLogsRetentionConfig_St */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerQuery.h b/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerQuery.h index f2ea2fefa..2a844ccf3 100644 --- a/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerQuery.h +++ b/Sources/GeneratedServices/CloudComposer/Public/GoogleAPIClientForREST/GTLRCloudComposerQuery.h @@ -1149,6 +1149,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudComposer_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexObjects.m b/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexObjects.m index 696c64f7f..8385fe0e8 100644 --- a/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexObjects.m +++ b/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexObjects.m @@ -143,6 +143,7 @@ // GTLRCloudDataplex_GoogleCloudDataplexV1DataScan.type NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataDiscovery = @"DATA_DISCOVERY"; +NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataDocumentation = @"DATA_DOCUMENTATION"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataProfile = @"DATA_PROFILE"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataQuality = @"DATA_QUALITY"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataScanTypeUnspecified = @"DATA_SCAN_TYPE_UNSPECIFIED"; @@ -167,6 +168,7 @@ // GTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent.trigger NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_OnDemand = @"ON_DEMAND"; +NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_OneTime = @"ONE_TIME"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_Schedule = @"SCHEDULE"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_TriggerUnspecified = @"TRIGGER_UNSPECIFIED"; @@ -193,6 +195,7 @@ // GTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob.type NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataDiscovery = @"DATA_DISCOVERY"; +NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataDocumentation = @"DATA_DOCUMENTATION"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataProfile = @"DATA_PROFILE"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataQuality = @"DATA_QUALITY"; NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataScanTypeUnspecified = @"DATA_SCAN_TYPE_UNSPECIFIED"; @@ -1188,6 +1191,98 @@ @implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDiscoverySpecStorageC @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResult +// + +@implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResult +@dynamic tableResult; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultField +// + +@implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultField +@dynamic descriptionProperty, fields, name; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"fields" : [GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultField class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultQuery +// + +@implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultQuery +@dynamic descriptionProperty, sql; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultSchema +// + +@implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultSchema +@dynamic fields; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"fields" : [GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultField class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultTableResult +// + +@implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultTableResult +@dynamic name, overview, queries, schema; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"queries" : [GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultQuery class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationSpec +// + +@implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationSpec +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudDataplex_GoogleCloudDataplexV1DataProfileResult @@ -1689,7 +1784,8 @@ @implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataQualitySpecPostScanAc @implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataScan @dynamic createTime, data, dataDiscoveryResult, dataDiscoverySpec, - dataProfileResult, dataProfileSpec, dataQualityResult, dataQualitySpec, + dataDocumentationResult, dataDocumentationSpec, dataProfileResult, + dataProfileSpec, dataQualityResult, dataQualitySpec, descriptionProperty, displayName, executionSpec, executionStatus, labels, name, state, type, uid, updateTime; @@ -1865,7 +1961,8 @@ @implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataScanExecutionStatus // @implementation GTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob -@dynamic createTime, dataDiscoveryResult, dataDiscoverySpec, dataProfileResult, +@dynamic createTime, dataDiscoveryResult, dataDiscoverySpec, + dataDocumentationResult, dataDocumentationSpec, dataProfileResult, dataProfileSpec, dataQualityResult, dataQualitySpec, endTime, message, name, startTime, state, type, uid; @end @@ -2004,8 +2101,8 @@ @implementation GTLRCloudDataplex_GoogleCloudDataplexV1DiscoveryEventTableDetail // @implementation GTLRCloudDataplex_GoogleCloudDataplexV1EncryptionConfig -@dynamic createTime, encryptionState, ETag, failureDetails, key, name, - updateTime; +@dynamic createTime, enableMetastoreEncryption, encryptionState, ETag, + failureDetails, key, name, updateTime; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"ETag" : @"etag" }; @@ -4128,11 +4225,12 @@ @implementation GTLRCloudDataplex_GoogleLongrunningCancelOperationRequest // @implementation GTLRCloudDataplex_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudDataplex_GoogleLongrunningOperation class] + @"operations" : [GTLRCloudDataplex_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexQuery.m b/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexQuery.m index a69fccc22..83b772dae 100644 --- a/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexQuery.m +++ b/Sources/GeneratedServices/CloudDataplex/GTLRCloudDataplexQuery.m @@ -299,7 +299,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudDataplexQuery_OrganizationsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -508,6 +508,83 @@ + (instancetype)queryWithObject:(GTLRCloudDataplex_GoogleIamV1TestIamPermissions @end +@implementation GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsGetIamPolicy + +@dynamic optionsRequestedPolicyVersion, resource; + ++ (NSDictionary *)parameterNameMap { + return @{ @"optionsRequestedPolicyVersion" : @"options.requestedPolicyVersion" }; +} + ++ (instancetype)queryWithResource:(NSString *)resource { + NSArray *pathParams = @[ @"resource" ]; + NSString *pathURITemplate = @"v1/{+resource}:getIamPolicy"; + GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsGetIamPolicy *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.resource = resource; + query.expectedObjectClass = [GTLRCloudDataplex_GoogleIamV1Policy class]; + query.loggingName = @"dataplex.projects.locations.changeRequests.getIamPolicy"; + return query; +} + +@end + +@implementation GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsSetIamPolicy + +@dynamic resource; + ++ (instancetype)queryWithObject:(GTLRCloudDataplex_GoogleIamV1SetIamPolicyRequest *)object + resource:(NSString *)resource { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"resource" ]; + NSString *pathURITemplate = @"v1/{+resource}:setIamPolicy"; + GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsSetIamPolicy *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.resource = resource; + query.expectedObjectClass = [GTLRCloudDataplex_GoogleIamV1Policy class]; + query.loggingName = @"dataplex.projects.locations.changeRequests.setIamPolicy"; + return query; +} + +@end + +@implementation GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsTestIamPermissions + +@dynamic resource; + ++ (instancetype)queryWithObject:(GTLRCloudDataplex_GoogleIamV1TestIamPermissionsRequest *)object + resource:(NSString *)resource { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"resource" ]; + NSString *pathURITemplate = @"v1/{+resource}:testIamPermissions"; + GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsTestIamPermissions *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.resource = resource; + query.expectedObjectClass = [GTLRCloudDataplex_GoogleIamV1TestIamPermissionsResponse class]; + query.loggingName = @"dataplex.projects.locations.changeRequests.testIamPermissions"; + return query; +} + +@end + @implementation GTLRCloudDataplexQuery_ProjectsLocationsDataAttributeBindingsCreate @dynamic dataAttributeBindingId, parent, validateOnly; @@ -4714,7 +4791,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudDataplexQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexObjects.h b/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexObjects.h index ed28bf90a..3870b8531 100644 --- a/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexObjects.h +++ b/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexObjects.h @@ -62,6 +62,12 @@ @class GTLRCloudDataplex_GoogleCloudDataplexV1DataDiscoverySpecStorageConfig; @class GTLRCloudDataplex_GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions; @class GTLRCloudDataplex_GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions; +@class GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResult; +@class GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultField; +@class GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultQuery; +@class GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultSchema; +@class GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultTableResult; +@class GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationSpec; @class GTLRCloudDataplex_GoogleCloudDataplexV1DataProfileResult; @class GTLRCloudDataplex_GoogleCloudDataplexV1DataProfileResultPostScanActionsResult; @class GTLRCloudDataplex_GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult; @@ -858,6 +864,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataS * Value: "DATA_DISCOVERY" */ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataDiscovery; +/** + * Data documentation scan. + * + * Value: "DATA_DOCUMENTATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataDocumentation; /** * Data profile scan. * @@ -970,6 +982,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataS * Value: "ON_DEMAND" */ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_OnDemand; +/** + * Data scan is run one time on creation. + * + * Value: "ONE_TIME" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_OneTime; /** * Data scan triggers as per schedule. * @@ -1095,6 +1113,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataS * Value: "DATA_DISCOVERY" */ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataDiscovery; +/** + * Data documentation scan. + * + * Value: "DATA_DOCUMENTATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataDocumentation; /** * Data profile scan. * @@ -4273,6 +4297,101 @@ GTLR_DEPRECATED @end +/** + * The output of a DataDocumentation scan. + */ +@interface GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResult : GTLRObject + +/** Output only. Table result for insights. */ +@property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultTableResult *tableResult; + +@end + + +/** + * Column of a table with generated metadata and nested fields. + */ +@interface GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultField : GTLRObject + +/** + * Output only. Generated description for columns and fields. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** Output only. Nested fields. */ +@property(nonatomic, strong, nullable) NSArray *fields; + +/** Output only. The name of the column. */ +@property(nonatomic, copy, nullable) NSString *name; + +@end + + +/** + * A sample SQL query in data documentation. + */ +@interface GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultQuery : GTLRObject + +/** + * Output only. The description for the query. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** Output only. The SQL query string which can be executed. */ +@property(nonatomic, copy, nullable) NSString *sql; + +@end + + +/** + * Schema of the table with generated metadata of columns. + */ +@interface GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultSchema : GTLRObject + +/** Output only. The list of columns. */ +@property(nonatomic, strong, nullable) NSArray *fields; + +@end + + +/** + * Generated metadata about the table. + */ +@interface GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultTableResult : GTLRObject + +/** + * Output only. The service-qualified full resource name of the cloud resource. + * Ex: + * //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Output only. Generated description of the table. */ +@property(nonatomic, copy, nullable) NSString *overview; + +/** Output only. Sample SQL queries for the table. */ +@property(nonatomic, strong, nullable) NSArray *queries; + +/** + * Output only. Schema of the table with generated metadata of the columns in + * the schema. + */ +@property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResultSchema *schema; + +@end + + +/** + * DataDocumentation scan related spec. + */ +@interface GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationSpec : GTLRObject +@end + + /** * DataProfileResult defines the output of DataProfileScan. Each field of the * table will have field type specific profile result. @@ -5475,7 +5594,11 @@ GTLR_DEPRECATED * (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data * discovery: scans data in Cloud Storage buckets to extract and then catalog * metadata. For more information, see Discover and catalog Cloud Storage data - * (https://cloud.google.com/bigquery/docs/automatic-discovery). + * (https://cloud.google.com/bigquery/docs/automatic-discovery). Data + * documentation: analyzes the table details and generates insights including + * descriptions and sample SQL queries for the table. For more information, see + * Generate data insights in BigQuery + * (https://cloud.google.com/bigquery/docs/data-insights). */ @interface GTLRCloudDataplex_GoogleCloudDataplexV1DataScan : GTLRObject @@ -5491,6 +5614,12 @@ GTLR_DEPRECATED /** Settings for a data discovery scan. */ @property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDiscoverySpec *dataDiscoverySpec; +/** Output only. The result of a data documentation scan. */ +@property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResult *dataDocumentationResult; + +/** Settings for a data documentation scan. */ +@property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationSpec *dataDocumentationSpec; + /** Output only. The result of a data profile scan. */ @property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataProfileResult *dataProfileResult; @@ -5557,6 +5686,8 @@ GTLR_DEPRECATED * Likely values: * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataDiscovery * Data discovery scan. (Value: "DATA_DISCOVERY") + * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataDocumentation + * Data documentation scan. (Value: "DATA_DOCUMENTATION") * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataProfile * Data profile scan. (Value: "DATA_PROFILE") * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScan_Type_DataQuality @@ -5699,6 +5830,8 @@ GTLR_DEPRECATED * Likely values: * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_OnDemand * Data scan triggers on demand. (Value: "ON_DEMAND") + * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_OneTime + * Data scan is run one time on creation. (Value: "ONE_TIME") * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_Schedule * Data scan triggers as per schedule. (Value: "SCHEDULE") * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanEvent_Trigger_TriggerUnspecified @@ -5978,6 +6111,12 @@ GTLR_DEPRECATED /** Output only. Settings for a data discovery scan. */ @property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDiscoverySpec *dataDiscoverySpec; +/** Output only. The result of a data documentation scan. */ +@property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationResult *dataDocumentationResult; + +/** Output only. Settings for a data documentation scan. */ +@property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataDocumentationSpec *dataDocumentationSpec; + /** Output only. The result of a data profile scan. */ @property(nonatomic, strong, nullable) GTLRCloudDataplex_GoogleCloudDataplexV1DataProfileResult *dataProfileResult; @@ -6037,6 +6176,8 @@ GTLR_DEPRECATED * Likely values: * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataDiscovery * Data discovery scan. (Value: "DATA_DISCOVERY") + * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataDocumentation + * Data documentation scan. (Value: "DATA_DOCUMENTATION") * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataProfile * Data profile scan. (Value: "DATA_PROFILE") * @arg @c kGTLRCloudDataplex_GoogleCloudDataplexV1DataScanJob_Type_DataQuality @@ -6070,7 +6211,8 @@ GTLR_DEPRECATED * for a DataScan job to scan against. The field could either be: Cloud Storage * bucket for DataDiscoveryScan Format: * //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery - * table of type "TABLE" for DataProfileScan/DataQualityScan Format: + * table of type "TABLE" for + * DataProfileScan/DataQualityScan/DataDocumentationScan Format: * //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID */ @property(nonatomic, copy, nullable) NSString *resource; @@ -6379,6 +6521,13 @@ GTLR_DEPRECATED /** Output only. The time when the Encryption configuration was created. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Optional. Represent the state of CMEK opt-in for metastore. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableMetastoreEncryption; + /** * Output only. The state of encryption of the databases. * @@ -9140,12 +9289,12 @@ GTLR_DEPRECATED @property(nonatomic, strong, nullable) NSArray *aspectTypes; /** - * Required. The entry group that is in scope for the import job, specified as - * a relative resource name in the format + * Required. The entry groups that are in scope for the import job, specified + * as relative resource names in the format * projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. - * Only entries and aspects that belong to the specified entry group are - * affected by the job.Must contain exactly one element. The entry group and - * the job must be in the same location. + * Only entries and aspects that belong to the specified entry groups are + * affected by the job.The entry groups and the job must be in the same + * location. */ @property(nonatomic, strong, nullable) NSArray *entryGroups; @@ -11134,6 +11283,13 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * ListOperationsRequest.return_partial_success and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexQuery.h b/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexQuery.h index fd50f5759..73c2f45ef 100644 --- a/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexQuery.h +++ b/Sources/GeneratedServices/CloudDataplex/Public/GoogleAPIClientForREST/GTLRCloudDataplexQuery.h @@ -572,6 +572,17 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplexViewTables; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when parent is set to + * "projects/example/locations/-".This field is not by default supported and + * will result in an UNIMPLEMENTED error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudDataplex_GoogleLongrunningListOperationsResponse. * @@ -947,6 +958,140 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDataplexViewTables; @end +/** + * Gets the access control policy for a resource. Returns an empty policy if + * the resource exists and does not have a policy set. + * + * Method: dataplex.projects.locations.changeRequests.getIamPolicy + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudDataplexCloudPlatform + */ +@interface GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsGetIamPolicy : GTLRCloudDataplexQuery + +/** + * Optional. The maximum policy version that will be used to format the + * policy.Valid values are 0, 1, and 3. Requests specifying an invalid value + * will be rejected.Requests for policies with any conditional role bindings + * must specify version 3. Policies with no conditional role bindings may + * specify any valid value or leave the field unset.The policy in the response + * might use the policy version that you specified, or it might use a lower + * policy version. For example, if you specify version 3, but the policy has no + * conditional role bindings, the response uses version 1.To learn which + * resources support conditions in their IAM policies, see the IAM + * documentation + * (https://cloud.google.com/iam/help/conditions/resource-policies). + */ +@property(nonatomic, assign) NSInteger optionsRequestedPolicyVersion; + +/** + * REQUIRED: The resource for which the policy is being requested. See Resource + * names (https://cloud.google.com/apis/design/resource_names) for the + * appropriate value for this field. + */ +@property(nonatomic, copy, nullable) NSString *resource; + +/** + * Fetches a @c GTLRCloudDataplex_GoogleIamV1Policy. + * + * Gets the access control policy for a resource. Returns an empty policy if + * the resource exists and does not have a policy set. + * + * @param resource REQUIRED: The resource for which the policy is being + * requested. See Resource names + * (https://cloud.google.com/apis/design/resource_names) for the appropriate + * value for this field. + * + * @return GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsGetIamPolicy + */ ++ (instancetype)queryWithResource:(NSString *)resource; + +@end + +/** + * Sets the access control policy on the specified resource. Replaces any + * existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + * PERMISSION_DENIED errors. + * + * Method: dataplex.projects.locations.changeRequests.setIamPolicy + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudDataplexCloudPlatform + */ +@interface GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsSetIamPolicy : GTLRCloudDataplexQuery + +/** + * REQUIRED: The resource for which the policy is being specified. See Resource + * names (https://cloud.google.com/apis/design/resource_names) for the + * appropriate value for this field. + */ +@property(nonatomic, copy, nullable) NSString *resource; + +/** + * Fetches a @c GTLRCloudDataplex_GoogleIamV1Policy. + * + * Sets the access control policy on the specified resource. Replaces any + * existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + * PERMISSION_DENIED errors. + * + * @param object The @c GTLRCloudDataplex_GoogleIamV1SetIamPolicyRequest to + * include in the query. + * @param resource REQUIRED: The resource for which the policy is being + * specified. See Resource names + * (https://cloud.google.com/apis/design/resource_names) for the appropriate + * value for this field. + * + * @return GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsSetIamPolicy + */ ++ (instancetype)queryWithObject:(GTLRCloudDataplex_GoogleIamV1SetIamPolicyRequest *)object + resource:(NSString *)resource; + +@end + +/** + * Returns permissions that a caller has on the specified resource. If the + * resource does not exist, this will return an empty set of permissions, not a + * NOT_FOUND error.Note: This operation is designed to be used for building + * permission-aware UIs and command-line tools, not for authorization checking. + * This operation may "fail open" without warning. + * + * Method: dataplex.projects.locations.changeRequests.testIamPermissions + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudDataplexCloudPlatform + */ +@interface GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsTestIamPermissions : GTLRCloudDataplexQuery + +/** + * 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. + */ +@property(nonatomic, copy, nullable) NSString *resource; + +/** + * Fetches a @c GTLRCloudDataplex_GoogleIamV1TestIamPermissionsResponse. + * + * Returns permissions that a caller has on the specified resource. If the + * resource does not exist, this will return an empty set of permissions, not a + * NOT_FOUND error.Note: This operation is designed to be used for building + * permission-aware UIs and command-line tools, not for authorization checking. + * This operation may "fail open" without warning. + * + * @param object The @c GTLRCloudDataplex_GoogleIamV1TestIamPermissionsRequest + * to include in the query. + * @param resource 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. + * + * @return GTLRCloudDataplexQuery_ProjectsLocationsChangeRequestsTestIamPermissions + */ ++ (instancetype)queryWithObject:(GTLRCloudDataplex_GoogleIamV1TestIamPermissionsRequest *)object + resource:(NSString *)resource; + +@end + /** * Create a DataAttributeBinding resource. * @@ -2973,7 +3118,11 @@ GTLR_DEPRECATED @end /** - * Gets an Entry. + * Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, + * and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog + * is changing. For more information, see Changes to metadata stored in + * Dataplex Universal Catalog + * (https://cloud.google.com/dataplex/docs/metadata-changes). * * Method: dataplex.projects.locations.entryGroups.entries.get * @@ -3021,7 +3170,11 @@ GTLR_DEPRECATED /** * Fetches a @c GTLRCloudDataplex_GoogleCloudDataplexV1Entry. * - * Gets an Entry. + * Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, + * and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog + * is changing. For more information, see Changes to metadata stored in + * Dataplex Universal Catalog + * (https://cloud.google.com/dataplex/docs/metadata-changes). * * @param name Required. The resource name of the Entry: * projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. @@ -3033,7 +3186,11 @@ GTLR_DEPRECATED @end /** - * Lists Entries within an EntryGroup. + * Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, + * Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored + * in Dataplex Universal Catalog is changing. For more information, see Changes + * to metadata stored in Dataplex Universal Catalog + * (https://cloud.google.com/dataplex/docs/metadata-changes). * * Method: dataplex.projects.locations.entryGroups.entries.list * @@ -3080,7 +3237,11 @@ GTLR_DEPRECATED /** * Fetches a @c GTLRCloudDataplex_GoogleCloudDataplexV1ListEntriesResponse. * - * Lists Entries within an EntryGroup. + * Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, + * Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored + * in Dataplex Universal Catalog is changing. For more information, see Changes + * to metadata stored in Dataplex Universal Catalog + * (https://cloud.google.com/dataplex/docs/metadata-changes). * * @param parent Required. The resource name of the parent Entry Group: * projects/{project}/locations/{location}/entryGroups/{entry_group}. @@ -8495,6 +8656,10 @@ GTLR_DEPRECATED /** * Looks up an entry by name using the permission on the source system. + * Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc + * Metastore metadata that is stored in Dataplex Universal Catalog is changing. + * For more information, see Changes to metadata stored in Dataplex Universal + * Catalog (https://cloud.google.com/dataplex/docs/metadata-changes). * * Method: dataplex.projects.locations.lookupEntry * @@ -8549,6 +8714,10 @@ GTLR_DEPRECATED * Fetches a @c GTLRCloudDataplex_GoogleCloudDataplexV1Entry. * * Looks up an entry by name using the permission on the source system. + * Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc + * Metastore metadata that is stored in Dataplex Universal Catalog is changing. + * For more information, see Changes to metadata stored in Dataplex Universal + * Catalog (https://cloud.google.com/dataplex/docs/metadata-changes). * * @param name Required. The project to which the request should be attributed * in the following form: projects/{project}/locations/{location}. @@ -8870,6 +9039,17 @@ GTLR_DEPRECATED /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when parent is set to + * "projects/example/locations/-".This field is not by default supported and + * will result in an UNIMPLEMENTED error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudDataplex_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployObjects.m b/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployObjects.m index 72ed42d69..3140affd0 100644 --- a/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployObjects.m +++ b/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployObjects.m @@ -1682,11 +1682,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCloudDeploy_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudDeploy_Operation class] + @"operations" : [GTLRCloudDeploy_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployQuery.m b/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployQuery.m index 8b52ee167..4b734511d 100644 --- a/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployQuery.m +++ b/Sources/GeneratedServices/CloudDeploy/GTLRCloudDeployQuery.m @@ -1246,7 +1246,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudDeployQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployObjects.h b/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployObjects.h index 85d923de9..63c0727b6 100644 --- a/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployObjects.h +++ b/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployObjects.h @@ -4677,6 +4677,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDeploy_WeeklyWindow_DaysOfWeek_Wedn */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployQuery.h b/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployQuery.h index 2a0670c3e..58924e2a9 100644 --- a/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployQuery.h +++ b/Sources/GeneratedServices/CloudDeploy/Public/GoogleAPIClientForREST/GTLRCloudDeployQuery.h @@ -2336,8 +2336,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCloudDeployQuery_ProjectsLocationsList : GTLRCloudDeployQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -2510,6 +2510,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudDeploy_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsObjects.m b/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsObjects.m index 648a90b87..7937d6f9e 100644 --- a/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsObjects.m +++ b/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsObjects.m @@ -138,6 +138,7 @@ NSString * const kGTLRCloudDomains_Registration_DomainProperties_TransferLockUnsupportedByRegistry = @"TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY"; // GTLRCloudDomains_Registration.issues +NSString * const kGTLRCloudDomains_Registration_Issues_AutoRenewalUpdateNotEffective = @"AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE"; NSString * const kGTLRCloudDomains_Registration_Issues_ContactSupport = @"CONTACT_SUPPORT"; NSString * const kGTLRCloudDomains_Registration_Issues_DnsNotActivated = @"DNS_NOT_ACTIVATED"; NSString * const kGTLRCloudDomains_Registration_Issues_IssueUnspecified = @"ISSUE_UNSPECIFIED"; diff --git a/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsQuery.m b/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsQuery.m index 5e64349c7..480a271f0 100644 --- a/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsQuery.m +++ b/Sources/GeneratedServices/CloudDomains/GTLRCloudDomainsQuery.m @@ -40,7 +40,14 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudDomainsQuery_ProjectsLocationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic extraLocationTypes, filter, name, pageSize, pageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"extraLocationTypes" : [NSString class] + }; + return map; +} + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsObjects.h b/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsObjects.h index d194b1208..6f962a5ba 100644 --- a/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsObjects.h +++ b/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsObjects.h @@ -705,6 +705,15 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudDomains_Registration_DomainProperti // ---------------------------------------------------------------------------- // GTLRCloudDomains_Registration.issues +/** + * Due to SquareSpace's constraints, the auto-renewal update you made may not + * be effective during a certain period of time. Generally, the time period is + * 15 days before expiration for generic TLD domains, and 15 days before + * expiration + 3 days after expiration for country-code TLD domains. + * + * Value: "AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudDomains_Registration_Issues_AutoRenewalUpdateNotEffective; /** * Contact the Cloud Support team to resolve a problem with this domain. * @@ -2427,48 +2436,48 @@ GTLR_DEPRECATED /** - * Represents a postal address. For example for postal delivery or payments - * addresses. Given a postal address, a postal service can deliver items to a - * premise, P.O. Box or similar. It is not intended to model geographical - * locations (roads, towns, mountains). In typical usage an address would be - * created by user input or from importing existing data, depending on the type - * of process. Advice on address input / editing: - Use an - * internationalization-ready address widget such as - * https://github.com/google/libaddressinput) - Users should not be presented + * Represents a postal address, such as for postal delivery or payments + * addresses. With a postal address, a postal service can deliver items to a + * premise, P.O. box, or similar. A postal address is not intended to model + * geographical locations like roads, towns, or mountains. In typical usage, an + * address would be created by user input or from importing existing data, + * depending on the type of process. Advice on address input or editing: - Use + * an internationalization-ready address widget such as + * https://github.com/google/libaddressinput. - Users should not be presented * with UI elements for input or editing of fields outside countries where that * field is used. For more guidance on how to use this schema, see: - * https://support.google.com/business/answer/6397478 + * https://support.google.com/business/answer/6397478. */ @interface GTLRCloudDomains_PostalAddress : GTLRObject /** * Unstructured address lines describing the lower levels of an address. - * Because values in address_lines do not have type information and may - * sometimes contain multiple values in a single field (For example "Austin, + * Because values in `address_lines` do not have type information and may + * sometimes contain multiple values in a single field (for example, "Austin, * TX"), it is important that the line order is clear. The order of address - * lines should be "envelope order" for the country/region of the address. In - * places where this can vary (For example Japan), address_language is used to - * make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" - * or "en" for small-to-large). This way, the most specific line of an address - * can be selected based on the language. The minimum permitted structural - * representation of an address consists of a region_code with all remaining - * information placed in the address_lines. It would be possible to format such - * an address very approximately without geocoding, but no semantic reasoning - * could be made about any of the address components until it was at least - * partially resolved. Creating an address only containing a region_code and - * address_lines, and then geocoding is the recommended way to handle - * completely unstructured addresses (as opposed to guessing which parts of the - * address should be localities or administrative areas). + * lines should be "envelope order" for the country or region of the address. + * In places where this can vary (for example, Japan), `address_language` is + * used to make it explicit (for example, "ja" for large-to-small ordering and + * "ja-Latn" or "en" for small-to-large). In this way, the most specific line + * of an address can be selected based on the language. The minimum permitted + * structural representation of an address consists of a `region_code` with all + * remaining information placed in the `address_lines`. It would be possible to + * format such an address very approximately without geocoding, but no semantic + * reasoning could be made about any of the address components until it was at + * least partially resolved. Creating an address only containing a + * `region_code` and `address_lines` and then geocoding is the recommended way + * to handle completely unstructured addresses (as opposed to guessing which + * parts of the address should be localities or administrative areas). */ @property(nonatomic, strong, nullable) NSArray *addressLines; /** * Optional. Highest administrative subdivision which is used for postal * addresses of a country or region. For example, this can be a state, a - * province, an oblast, or a prefecture. Specifically, for Spain this is the - * province and not the autonomous community (For example "Barcelona" and not - * "Catalonia"). Many countries don't use an administrative area in postal - * addresses. For example in Switzerland this should be left unpopulated. + * province, an oblast, or a prefecture. For Spain, this is the province and + * not the autonomous community (for example, "Barcelona" and not "Catalonia"). + * Many countries don't use an administrative area in postal addresses. For + * example, in Switzerland, this should be left unpopulated. */ @property(nonatomic, copy, nullable) NSString *administrativeArea; @@ -2485,10 +2494,10 @@ GTLR_DEPRECATED @property(nonatomic, copy, nullable) NSString *languageCode; /** - * Optional. Generally refers to the city/town portion of the address. + * Optional. Generally refers to the city or town portion of the address. * Examples: US city, IT comune, UK post town. In regions of the world where * localities are not well defined or do not fit into this structure well, - * leave locality empty and use address_lines. + * leave `locality` empty and use `address_lines`. */ @property(nonatomic, copy, nullable) NSString *locality; @@ -2498,8 +2507,8 @@ GTLR_DEPRECATED /** * Optional. Postal code of the address. Not all countries use or require * postal codes to be present, but where they are used, they may trigger - * additional validation with other parts of the address (For example state/zip - * validation in the U.S.A.). + * additional validation with other parts of the address (for example, state or + * zip code validation in the United States). */ @property(nonatomic, copy, nullable) NSString *postalCode; @@ -2531,15 +2540,15 @@ GTLR_DEPRECATED /** * Optional. Additional, country-specific, sorting code. This is not used in * most regions. Where it is used, the value is either a string like "CEDEX", - * optionally followed by a number (For example "CEDEX 7"), or just a number + * optionally followed by a number (for example, "CEDEX 7"), or just a number * alone, representing the "sector code" (Jamaica), "delivery area indicator" - * (Malawi) or "post office indicator" (For example Côte d'Ivoire). + * (Malawi) or "post office indicator" (Côte d'Ivoire). */ @property(nonatomic, copy, nullable) NSString *sortingCode; /** - * Optional. Sublocality of the address. For example, this can be - * neighborhoods, boroughs, districts. + * Optional. Sublocality of the address. For example, this can be a + * neighborhood, borough, or district. */ @property(nonatomic, copy, nullable) NSString *sublocality; diff --git a/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsQuery.h b/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsQuery.h index a900a2dd7..152758e46 100644 --- a/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsQuery.h +++ b/Sources/GeneratedServices/CloudDomains/Public/GoogleAPIClientForREST/GTLRCloudDomainsQuery.h @@ -69,6 +69,12 @@ NS_ASSUME_NONNULL_BEGIN */ @interface GTLRCloudDomainsQuery_ProjectsLocationsList : GTLRCloudDomainsQuery +/** + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. + */ +@property(nonatomic, strong, nullable) NSArray *extraLocationTypes; + /** * A filter to narrow down results to a preferred subset. The filtering * language accepts strings like `"displayName=tokyo"`, and is documented in diff --git a/Sources/GeneratedServices/CloudFilestore/Public/GoogleAPIClientForREST/GTLRCloudFilestoreQuery.h b/Sources/GeneratedServices/CloudFilestore/Public/GoogleAPIClientForREST/GTLRCloudFilestoreQuery.h index 81ad059f3..4d0f3ce9a 100644 --- a/Sources/GeneratedServices/CloudFilestore/Public/GoogleAPIClientForREST/GTLRCloudFilestoreQuery.h +++ b/Sources/GeneratedServices/CloudFilestore/Public/GoogleAPIClientForREST/GTLRCloudFilestoreQuery.h @@ -790,8 +790,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCloudFilestoreQuery_ProjectsLocationsList : GTLRCloudFilestoreQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsObjects.m b/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsObjects.m index 5c485cbd8..7124660e5 100644 --- a/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsObjects.m +++ b/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsObjects.m @@ -519,11 +519,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCloudFunctions_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudFunctions_Operation class] + @"operations" : [GTLRCloudFunctions_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsQuery.m b/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsQuery.m index 9ab9fb960..80133bcd6 100644 --- a/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsQuery.m +++ b/Sources/GeneratedServices/CloudFunctions/GTLRCloudFunctionsQuery.m @@ -467,7 +467,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudFunctionsQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsObjects.h b/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsObjects.h index 7dbf0c3ac..9f4f88d27 100644 --- a/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsObjects.h +++ b/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsObjects.h @@ -1655,6 +1655,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudFunctions_UpgradeInfo_UpgradeState_ */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsQuery.h b/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsQuery.h index 19e1419b0..c1c141ac9 100644 --- a/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsQuery.h +++ b/Sources/GeneratedServices/CloudFunctions/Public/GoogleAPIClientForREST/GTLRCloudFunctionsQuery.h @@ -813,6 +813,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudFunctions_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareObjects.h b/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareObjects.h index 9ca26af80..c683a4fe1 100644 --- a/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareObjects.h +++ b/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareObjects.h @@ -524,7 +524,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcare_ConsentHeaderHandling_Pr /** * Remove tags based on DICOM Standard's Attribute Confidentiality Basic * Profile (DICOM Standard Edition 2018e) - * http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. + * https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. * * Value: "ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE" */ @@ -2691,7 +2691,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcare_Type_Primitive_Varies; * @arg @c kGTLRCloudHealthcare_DicomConfig_FilterProfile_AttributeConfidentialityBasicProfile * Remove tags based on DICOM Standard's Attribute Confidentiality Basic * Profile (DICOM Standard Edition 2018e) - * http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. + * https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. * (Value: "ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE") * @arg @c kGTLRCloudHealthcare_DicomConfig_FilterProfile_DeidentifyTagContents * Inspects within tag contents and replaces sensitive text. The process @@ -2723,7 +2723,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcare_Type_Primitive_Varies; * individual out of context, given access to the original images, or to a * database of the original images containing the UIDs, it would be possible to * recover the individual's identity." - * http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html + * https://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html * * Uses NSNumber of boolValue. */ @@ -6721,7 +6721,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcare_Type_Primitive_Varies; /** * Optional. Tags to be filtered. Tags must be DICOM Data Elements, File Meta * Elements, or Directory Structuring Elements, as defined at: - * http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. + * https://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. * They may be provided by "Keyword" or "Tag". For example "PatientID", * "00100010". */ diff --git a/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareQuery.h b/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareQuery.h index f9f5b0eb9..f27d415a5 100644 --- a/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareQuery.h +++ b/Sources/GeneratedServices/CloudHealthcare/Public/GoogleAPIClientForREST/GTLRCloudHealthcareQuery.h @@ -2500,7 +2500,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * SearchForInstances returns a list of matching instances. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForInstances, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2533,7 +2533,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * SearchForInstances returns a list of matching instances. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForInstances, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2556,7 +2556,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * SearchForSeries returns a list of matching series. See [Search Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForSeries, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2587,7 +2587,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * Fetches a @c GTLRCloudHealthcare_HttpBody. * * SearchForSeries returns a list of matching series. See [Search Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForSeries, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2610,7 +2610,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * SearchForStudies returns a list of matching studies. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForStudies, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2642,7 +2642,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * SearchForStudies returns a list of matching studies. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForStudies, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2756,7 +2756,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * StoreInstances stores DICOM instances associated with study instance unique * identifiers (SUID). See [Store Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). * For details on the implementation of StoreInstances, see [Store * transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2788,7 +2788,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * StoreInstances stores DICOM instances associated with study instance unique * identifiers (SUID). See [Store Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). * For details on the implementation of StoreInstances, see [Store * transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2861,7 +2861,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * RetrieveStudyMetadata returns instance associated with the given study * presented as metadata. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveStudyMetadata, see [Metadata * resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2893,7 +2893,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * RetrieveStudyMetadata returns instance associated with the given study * presented as metadata. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveStudyMetadata, see [Metadata * resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2916,7 +2916,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * RetrieveStudy returns all instances within the given study. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveStudy, see [DICOM * study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2948,7 +2948,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * RetrieveStudy returns all instances within the given study. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveStudy, see [DICOM * study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -2971,7 +2971,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * SearchForInstances returns a list of matching instances. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForInstances, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3004,7 +3004,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * SearchForInstances returns a list of matching instances. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForInstances, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3027,7 +3027,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * SearchForSeries returns a list of matching series. See [Search Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForSeries, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3058,7 +3058,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * Fetches a @c GTLRCloudHealthcare_HttpBody. * * SearchForSeries returns a list of matching series. See [Search Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForSeries, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3136,7 +3136,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * Returns uncompressed, unencoded bytes representing the referenced bulkdata * tag from an instance. See [Retrieve - * Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveBulkdata, see [Bulkdata * resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3168,7 +3168,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * Returns uncompressed, unencoded bytes representing the referenced bulkdata * tag from an instance. See [Retrieve - * Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * Transaction](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveBulkdata, see [Bulkdata * resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3246,7 +3246,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * RetrieveFrames returns instances associated with the given study, series, * SOP Instance UID and frame numbers. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. * For details on the implementation of RetrieveFrames, see [DICOM * frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the * Cloud Healthcare API conformance statement. For samples that show how to @@ -3278,7 +3278,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * RetrieveFrames returns instances associated with the given study, series, * SOP Instance UID and frame numbers. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. * For details on the implementation of RetrieveFrames, see [DICOM * frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the * Cloud Healthcare API conformance statement. For samples that show how to @@ -3303,7 +3303,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * RetrieveRenderedFrames returns instances associated with the given study, * series, SOP Instance UID and frame numbers in an acceptable Rendered Media * Type. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveRenderedFrames, see [Rendered * resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3343,7 +3343,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * RetrieveRenderedFrames returns instances associated with the given study, * series, SOP Instance UID and frame numbers in an acceptable Rendered Media * Type. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveRenderedFrames, see [Rendered * resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3367,7 +3367,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * RetrieveInstance returns instance associated with the given study, series, * and SOP Instance UID. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveInstance, see [DICOM * study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) * and [DICOM @@ -3401,7 +3401,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * RetrieveInstance returns instance associated with the given study, series, * and SOP Instance UID. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveInstance, see [DICOM * study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) * and [DICOM @@ -3428,7 +3428,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * RetrieveInstanceMetadata returns instance associated with the given study, * series, and SOP Instance UID presented as metadata. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveInstanceMetadata, see [Metadata * resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3462,7 +3462,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * RetrieveInstanceMetadata returns instance associated with the given study, * series, and SOP Instance UID presented as metadata. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveInstanceMetadata, see [Metadata * resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3487,7 +3487,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * RetrieveRenderedInstance returns instance associated with the given study, * series, and SOP Instance UID in an acceptable Rendered Media Type. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveRenderedInstance, see [Rendered * resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3527,7 +3527,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * RetrieveRenderedInstance returns instance associated with the given study, * series, and SOP Instance UID in an acceptable Rendered Media Type. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveRenderedInstance, see [Rendered * resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3551,7 +3551,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * RetrieveSeriesMetadata returns instance associated with the given study and * series, presented as metadata. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveSeriesMetadata, see [Metadata * resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3583,7 +3583,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * RetrieveSeriesMetadata returns instance associated with the given study and * series, presented as metadata. See [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveSeriesMetadata, see [Metadata * resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3607,7 +3607,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * RetrieveSeries returns all instances within the given study and series. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveSeries, see [DICOM * study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3639,7 +3639,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * RetrieveSeries returns all instances within the given study and series. See * [RetrieveTransaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). * For details on the implementation of RetrieveSeries, see [DICOM * study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3662,7 +3662,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * SearchForInstances returns a list of matching instances. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForInstances, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3695,7 +3695,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * SearchForInstances returns a list of matching instances. See [Search * Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). * For details on the implementation of SearchForInstances, see [Search * transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3719,7 +3719,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; /** * StoreInstances stores DICOM instances associated with study instance unique * identifiers (SUID). See [Store Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). * For details on the implementation of StoreInstances, see [Store * transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -3751,7 +3751,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; * * StoreInstances stores DICOM instances associated with study instance unique * identifiers (SUID). See [Store Transaction] - * (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). + * (https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). * For details on the implementation of StoreInstances, see [Store * transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) * in the Cloud Healthcare API conformance statement. For samples that show how @@ -8080,8 +8080,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudHealthcareViewSchematizedOnly; @interface GTLRCloudHealthcareQuery_ProjectsLocationsList : GTLRCloudHealthcareQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/CloudIdentity/GTLRCloudIdentityQuery.m b/Sources/GeneratedServices/CloudIdentity/GTLRCloudIdentityQuery.m index 4a8537f23..7d4bb67b3 100644 --- a/Sources/GeneratedServices/CloudIdentity/GTLRCloudIdentityQuery.m +++ b/Sources/GeneratedServices/CloudIdentity/GTLRCloudIdentityQuery.m @@ -421,7 +421,8 @@ + (instancetype)queryWithParent:(NSString *)parent { @implementation GTLRCloudIdentityQuery_DevicesDeviceUsersLookup -@dynamic androidId, pageSize, pageToken, parent, rawResourceId, userId; +@dynamic androidId, iosDeviceId, pageSize, pageToken, parent, partner, + rawResourceId, userId; + (instancetype)queryWithParent:(NSString *)parent { NSArray *pathParams = @[ @"parent" ]; diff --git a/Sources/GeneratedServices/CloudIdentity/Public/GoogleAPIClientForREST/GTLRCloudIdentityQuery.h b/Sources/GeneratedServices/CloudIdentity/Public/GoogleAPIClientForREST/GTLRCloudIdentityQuery.h index b91b9c8fb..4dd96e250 100644 --- a/Sources/GeneratedServices/CloudIdentity/Public/GoogleAPIClientForREST/GTLRCloudIdentityQuery.h +++ b/Sources/GeneratedServices/CloudIdentity/Public/GoogleAPIClientForREST/GTLRCloudIdentityQuery.h @@ -957,10 +957,10 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudIdentityViewViewUnspecified; * properties are provided, only DeviceUsers having all of these properties are * considered as matches - i.e. the query behaves like an AND. Different * platforms require different amounts of information from the caller to ensure - * that the DeviceUser is uniquely identified. - iOS: No properties need to be - * passed, the caller's credentials are sufficient to identify the - * corresponding DeviceUser. - Android: Specifying the 'android_id' field is - * required. - Desktop: Specifying the 'raw_resource_id' field is required. + * that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' + * and 'ios_device_id' fields is required. - Android: Specifying the + * 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' + * field is required. * * Method: cloudidentity.devices.deviceUsers.lookup * @@ -975,6 +975,14 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudIdentityViewViewUnspecified; */ @property(nonatomic, copy, nullable) NSString *androidId; +/** + * Optional. The partner-specified device identifier assigned to the iOS device + * that initiated the Lookup API call. This string must match the value of the + * iosDeviceId key in the app config dictionary provided to Google Workspace + * apps. + */ +@property(nonatomic, copy, nullable) NSString *iosDeviceId; + /** * The maximum number of DeviceUsers to return. If unspecified, at most 20 * DeviceUsers will be returned. The maximum value is 20; values above 20 will @@ -996,13 +1004,20 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudIdentityViewViewUnspecified; */ @property(nonatomic, copy, nullable) NSString *parent; +/** + * Optional. The partner ID of the calling iOS app. This string must match the + * value of the partner key within the app configuration dictionary provided to + * Google Workspace apps. + */ +@property(nonatomic, copy, nullable) NSString *partner; + /** * Raw Resource Id used by Google Endpoint Verification. If the user is * enrolled into Google Endpoint Verification, this id will be saved as the - * 'device_resource_id' field in the following platform dependent files. * - * macOS: ~/.secureConnect/context_aware_config.json * Windows: - * %USERPROFILE%\\AppData\\Local\\Google\\Endpoint Verification\\accounts.json - * * Linux: ~/.secureConnect/context_aware_config.json + * 'device_resource_id' field in the following platform dependent files. Mac: + * ~/.secureConnect/context_aware_config.json Windows: + * C:\\Users\\%USERPROFILE%\\.secureConnect\\context_aware_config.json Linux: + * ~/.secureConnect/context_aware_config.json */ @property(nonatomic, copy, nullable) NSString *rawResourceId; @@ -1023,10 +1038,10 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudIdentityViewViewUnspecified; * properties are provided, only DeviceUsers having all of these properties are * considered as matches - i.e. the query behaves like an AND. Different * platforms require different amounts of information from the caller to ensure - * that the DeviceUser is uniquely identified. - iOS: No properties need to be - * passed, the caller's credentials are sufficient to identify the - * corresponding DeviceUser. - Android: Specifying the 'android_id' field is - * required. - Desktop: Specifying the 'raw_resource_id' field is required. + * that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' + * and 'ios_device_id' fields is required. - Android: Specifying the + * 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' + * field is required. * * @param parent Must be set to "devices/-/deviceUsers" to search across all * DeviceUser belonging to the user. diff --git a/Sources/GeneratedServices/CloudKMS/GTLRCloudKMSQuery.m b/Sources/GeneratedServices/CloudKMS/GTLRCloudKMSQuery.m index 9eec470b0..3889730b8 100644 --- a/Sources/GeneratedServices/CloudKMS/GTLRCloudKMSQuery.m +++ b/Sources/GeneratedServices/CloudKMS/GTLRCloudKMSQuery.m @@ -177,6 +177,25 @@ + (instancetype)queryWithObject:(GTLRCloudKMS_KeyAccessJustificationsPolicyConfi @end +@implementation GTLRCloudKMSQuery_ProjectsGetAutokeyConfig + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRCloudKMSQuery_ProjectsGetAutokeyConfig *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRCloudKMS_AutokeyConfig class]; + query.loggingName = @"cloudkms.projects.getAutokeyConfig"; + return query; +} + +@end + @implementation GTLRCloudKMSQuery_ProjectsGetKajPolicyConfig @dynamic name; @@ -1635,6 +1654,33 @@ + (instancetype)queryWithProject:(NSString *)project { @end +@implementation GTLRCloudKMSQuery_ProjectsUpdateAutokeyConfig + +@dynamic name, updateMask; + ++ (instancetype)queryWithObject:(GTLRCloudKMS_AutokeyConfig *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRCloudKMSQuery_ProjectsUpdateAutokeyConfig *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRCloudKMS_AutokeyConfig class]; + query.loggingName = @"cloudkms.projects.updateAutokeyConfig"; + return query; +} + +@end + @implementation GTLRCloudKMSQuery_ProjectsUpdateKajPolicyConfig @dynamic name, updateMask; diff --git a/Sources/GeneratedServices/CloudKMS/Public/GoogleAPIClientForREST/GTLRCloudKMSQuery.h b/Sources/GeneratedServices/CloudKMS/Public/GoogleAPIClientForREST/GTLRCloudKMSQuery.h index 99fc82968..5a9fe1d05 100644 --- a/Sources/GeneratedServices/CloudKMS/Public/GoogleAPIClientForREST/GTLRCloudKMSQuery.h +++ b/Sources/GeneratedServices/CloudKMS/Public/GoogleAPIClientForREST/GTLRCloudKMSQuery.h @@ -120,7 +120,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Returns the AutokeyConfig for a folder. + * Returns the AutokeyConfig for a folder or project. * * Method: cloudkms.folders.getAutokeyConfig * @@ -132,17 +132,19 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Required. Name of the AutokeyConfig resource, e.g. - * `folders/{FOLDER_NUMBER}/autokeyConfig`. + * `folders/{FOLDER_NUMBER}/autokeyConfig` or + * `projects/{PROJECT_NUMBER}/autokeyConfig`. */ @property(nonatomic, copy, nullable) NSString *name; /** * Fetches a @c GTLRCloudKMS_AutokeyConfig. * - * Returns the AutokeyConfig for a folder. + * Returns the AutokeyConfig for a folder or project. * * @param name Required. Name of the AutokeyConfig resource, e.g. - * `folders/{FOLDER_NUMBER}/autokeyConfig`. + * `folders/{FOLDER_NUMBER}/autokeyConfig` or + * `projects/{PROJECT_NUMBER}/autokeyConfig`. * * @return GTLRCloudKMSQuery_FoldersGetAutokeyConfig */ @@ -151,8 +153,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Gets the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Gets the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * Method: cloudkms.folders.getKajPolicyConfig * @@ -168,8 +170,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Fetches a @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig. * - * Gets the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Gets the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * @param name Required. The name of the KeyAccessJustificationsPolicyConfig to * get. @@ -232,8 +234,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Updates the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Updates the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * Method: cloudkms.folders.updateKajPolicyConfig * @@ -259,8 +261,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Fetches a @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig. * - * Updates the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Updates the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * @param object The @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig to * include in the query. @@ -276,8 +278,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Gets the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Gets the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * Method: cloudkms.organizations.getKajPolicyConfig * @@ -293,8 +295,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Fetches a @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig. * - * Gets the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Gets the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * @param name Required. The name of the KeyAccessJustificationsPolicyConfig to * get. @@ -306,8 +308,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Updates the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Updates the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * Method: cloudkms.organizations.updateKajPolicyConfig * @@ -333,8 +335,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Fetches a @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig. * - * Updates the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Updates the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * @param object The @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig to * include in the query. @@ -350,8 +352,41 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Gets the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Returns the AutokeyConfig for a folder or project. + * + * Method: cloudkms.projects.getAutokeyConfig + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudKMS + * @c kGTLRAuthScopeCloudKMSCloudPlatform + */ +@interface GTLRCloudKMSQuery_ProjectsGetAutokeyConfig : GTLRCloudKMSQuery + +/** + * Required. Name of the AutokeyConfig resource, e.g. + * `folders/{FOLDER_NUMBER}/autokeyConfig` or + * `projects/{PROJECT_NUMBER}/autokeyConfig`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRCloudKMS_AutokeyConfig. + * + * Returns the AutokeyConfig for a folder or project. + * + * @param name Required. Name of the AutokeyConfig resource, e.g. + * `folders/{FOLDER_NUMBER}/autokeyConfig` or + * `projects/{PROJECT_NUMBER}/autokeyConfig`. + * + * @return GTLRCloudKMSQuery_ProjectsGetAutokeyConfig + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Gets the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * Method: cloudkms.projects.getKajPolicyConfig * @@ -367,8 +402,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Fetches a @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig. * - * Gets the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Gets the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * @param name Required. The name of the KeyAccessJustificationsPolicyConfig to * get. @@ -2663,8 +2698,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @interface GTLRCloudKMSQuery_ProjectsLocationsList : GTLRCloudKMSQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -2881,8 +2916,59 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; @end /** - * Updates the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Updates the AutokeyConfig for a folder. The caller must have both + * `cloudkms.autokeyConfigs.update` permission on the parent folder and + * `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A + * KeyHandle creation in the folder's descendant projects will use this + * configuration to determine where to create the resulting CryptoKey. + * + * Method: cloudkms.projects.updateAutokeyConfig + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudKMS + * @c kGTLRAuthScopeCloudKMSCloudPlatform + */ +@interface GTLRCloudKMSQuery_ProjectsUpdateAutokeyConfig : GTLRCloudKMSQuery + +/** + * Identifier. Name of the AutokeyConfig resource, e.g. + * `folders/{FOLDER_NUMBER}/autokeyConfig` + * `projects/{PROJECT_NUMBER}/autokeyConfig`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Required. Masks which fields of the AutokeyConfig to update, e.g. + * `keyProject`. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLRCloudKMS_AutokeyConfig. + * + * Updates the AutokeyConfig for a folder. The caller must have both + * `cloudkms.autokeyConfigs.update` permission on the parent folder and + * `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A + * KeyHandle creation in the folder's descendant projects will use this + * configuration to determine where to create the resulting CryptoKey. + * + * @param object The @c GTLRCloudKMS_AutokeyConfig to include in the query. + * @param name Identifier. Name of the AutokeyConfig resource, e.g. + * `folders/{FOLDER_NUMBER}/autokeyConfig` + * `projects/{PROJECT_NUMBER}/autokeyConfig`. + * + * @return GTLRCloudKMSQuery_ProjectsUpdateAutokeyConfig + */ ++ (instancetype)queryWithObject:(GTLRCloudKMS_AutokeyConfig *)object + name:(NSString *)name; + +@end + +/** + * Updates the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * Method: cloudkms.projects.updateKajPolicyConfig * @@ -2908,8 +2994,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudKMSViewFull; /** * Fetches a @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig. * - * Updates the KeyAccessJustificationsPolicyConfig for a given - * organization/folder/projects. + * Updates the KeyAccessJustificationsPolicyConfig for a given organization, + * folder, or project. * * @param object The @c GTLRCloudKMS_KeyAccessJustificationsPolicyConfig to * include in the query. diff --git a/Sources/GeneratedServices/CloudMemorystoreforMemcached/Public/GoogleAPIClientForREST/GTLRCloudMemorystoreforMemcachedQuery.h b/Sources/GeneratedServices/CloudMemorystoreforMemcached/Public/GoogleAPIClientForREST/GTLRCloudMemorystoreforMemcachedQuery.h index f334a6a38..f022bd49a 100644 --- a/Sources/GeneratedServices/CloudMemorystoreforMemcached/Public/GoogleAPIClientForREST/GTLRCloudMemorystoreforMemcachedQuery.h +++ b/Sources/GeneratedServices/CloudMemorystoreforMemcached/Public/GoogleAPIClientForREST/GTLRCloudMemorystoreforMemcachedQuery.h @@ -438,8 +438,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCloudMemorystoreforMemcachedQuery_ProjectsLocationsList : GTLRCloudMemorystoreforMemcachedQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginObjects.m b/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginObjects.m index 89964b4e0..ad5dfec49 100644 --- a/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginObjects.m +++ b/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginObjects.m @@ -80,6 +80,26 @@ @implementation GTLRCloudOSLogin_PosixAccount @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudOSLogin_SignSshPublicKeyRequest +// + +@implementation GTLRCloudOSLogin_SignSshPublicKeyRequest +@dynamic appEngineInstance, computeInstance, serviceAccount, sshPublicKey; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudOSLogin_SignSshPublicKeyResponse +// + +@implementation GTLRCloudOSLogin_SignSshPublicKeyResponse +@dynamic signedSshPublicKey; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudOSLogin_SshPublicKey diff --git a/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginQuery.m b/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginQuery.m index de63309a0..68a7107ae 100644 --- a/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginQuery.m +++ b/Sources/GeneratedServices/CloudOSLogin/GTLRCloudOSLoginQuery.m @@ -16,6 +16,33 @@ @implementation GTLRCloudOSLoginQuery @end +@implementation GTLRCloudOSLoginQuery_ProjectsLocationsSignSshPublicKey + +@dynamic parent; + ++ (instancetype)queryWithObject:(GTLRCloudOSLogin_SignSshPublicKeyRequest *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}:signSshPublicKey"; + GTLRCloudOSLoginQuery_ProjectsLocationsSignSshPublicKey *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLRCloudOSLogin_SignSshPublicKeyResponse class]; + query.loggingName = @"oslogin.projects.locations.signSshPublicKey"; + return query; +} + +@end + @implementation GTLRCloudOSLoginQuery_UsersGetLoginProfile @dynamic name, projectId, systemId; diff --git a/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginObjects.h b/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginObjects.h index a00950d1d..0f448f97c 100644 --- a/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginObjects.h +++ b/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginObjects.h @@ -173,6 +173,48 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudOSLogin_PosixAccount_OperatingSyste @end +/** + * A request message for signing an SSH public key. + */ +@interface GTLRCloudOSLogin_SignSshPublicKeyRequest : GTLRObject + +/** + * The App Engine instance to sign the SSH public key for. Expected format: + * apps/{app}/services/{service}/versions/{version}/instances/{instance} + */ +@property(nonatomic, copy, nullable) NSString *appEngineInstance; + +/** + * The Compute instance to sign the SSH public key for. Expected format: + * projects/{project}/zones/{zone}/instances/{numeric_instance_id} + */ +@property(nonatomic, copy, nullable) NSString *computeInstance; + +/** + * Optional. The service account for the instance. If the instance in question + * does not have a service account, this field should be left empty. If the + * wrong service account is provided, this operation will return a signed + * certificate that will not be accepted by the VM. + */ +@property(nonatomic, copy, nullable) NSString *serviceAccount; + +/** Required. The SSH public key to sign. */ +@property(nonatomic, copy, nullable) NSString *sshPublicKey; + +@end + + +/** + * The response message for signing an SSH public key. + */ +@interface GTLRCloudOSLogin_SignSshPublicKeyResponse : GTLRObject + +/** The signed SSH public key to use in the SSH handshake. */ +@property(nonatomic, copy, nullable) NSString *signedSshPublicKey; + +@end + + /** * The SSH public key information associated with a Google account. */ diff --git a/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginQuery.h b/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginQuery.h index 396a6e91a..eb1cf94bd 100644 --- a/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginQuery.h +++ b/Sources/GeneratedServices/CloudOSLogin/Public/GoogleAPIClientForREST/GTLRCloudOSLoginQuery.h @@ -33,6 +33,41 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Signs an SSH public key for a user to authenticate to a virtual machine on + * Google Compute Engine. + * + * Method: oslogin.projects.locations.signSshPublicKey + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudOSLoginCloudPlatform + */ +@interface GTLRCloudOSLoginQuery_ProjectsLocationsSignSshPublicKey : GTLRCloudOSLoginQuery + +/** + * Required. The parent for the signing request. Format: + * projects/{project}/locations/{location} + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLRCloudOSLogin_SignSshPublicKeyResponse. + * + * Signs an SSH public key for a user to authenticate to a virtual machine on + * Google Compute Engine. + * + * @param object The @c GTLRCloudOSLogin_SignSshPublicKeyRequest to include in + * the query. + * @param parent Required. The parent for the signing request. Format: + * projects/{project}/locations/{location} + * + * @return GTLRCloudOSLoginQuery_ProjectsLocationsSignSshPublicKey + */ ++ (instancetype)queryWithObject:(GTLRCloudOSLogin_SignSshPublicKeyRequest *)object + parent:(NSString *)parent; + +@end + /** * Retrieves the profile information used for logging in to a virtual machine * on Google Compute Engine. diff --git a/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityObjects.m b/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityObjects.m index 807ff5074..75b0b93f7 100644 --- a/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityObjects.m +++ b/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityObjects.m @@ -54,11 +54,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCloudObservability_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudObservability_Operation class] + @"operations" : [GTLRCloudObservability_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityQuery.m b/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityQuery.m index 676400405..25ef8dae5 100644 --- a/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityQuery.m +++ b/Sources/GeneratedServices/CloudObservability/GTLRCloudObservabilityQuery.m @@ -126,7 +126,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudObservabilityQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityObjects.h b/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityObjects.h index fd2f72838..ae739bc88 100644 --- a/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityObjects.h +++ b/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityObjects.h @@ -91,6 +91,13 @@ NS_ASSUME_NONNULL_BEGIN */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityQuery.h b/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityQuery.h index fcec32c5a..c7d816bcb 100644 --- a/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityQuery.h +++ b/Sources/GeneratedServices/CloudObservability/Public/GoogleAPIClientForREST/GTLRCloudObservabilityQuery.h @@ -242,6 +242,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudObservability_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudRedis/GTLRCloudRedisObjects.m b/Sources/GeneratedServices/CloudRedis/GTLRCloudRedisObjects.m index 354cd27e4..681dc333e 100644 --- a/Sources/GeneratedServices/CloudRedis/GTLRCloudRedisObjects.m +++ b/Sources/GeneratedServices/CloudRedis/GTLRCloudRedisObjects.m @@ -112,6 +112,7 @@ // GTLRCloudRedis_DatabaseResourceFeed.feedType NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_BackupdrMetadata = @"BACKUPDR_METADATA"; NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_ConfigBasedSignalData = @"CONFIG_BASED_SIGNAL_DATA"; +NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_DatabaseResourceSignalData = @"DATABASE_RESOURCE_SIGNAL_DATA"; NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_FeedtypeUnspecified = @"FEEDTYPE_UNSPECIFIED"; NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_ObservabilityData = @"OBSERVABILITY_DATA"; NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_RecommendationSignalData = @"RECOMMENDATION_SIGNAL_DATA"; @@ -417,6 +418,20 @@ NSString * const kGTLRCloudRedis_DatabaseResourceRecommendationSignalData_SignalType_SignalTypeWeakPasswordHashAlgorithm = @"SIGNAL_TYPE_WEAK_PASSWORD_HASH_ALGORITHM"; NSString * const kGTLRCloudRedis_DatabaseResourceRecommendationSignalData_SignalType_SignalTypeWeakRootPassword = @"SIGNAL_TYPE_WEAK_ROOT_PASSWORD"; +// GTLRCloudRedis_DatabaseResourceSignalData.signalState +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Active = @"ACTIVE"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Dismissed = @"DISMISSED"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Inactive = @"INACTIVE"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_SignalStateUnspecified = @"SIGNAL_STATE_UNSPECIFIED"; + +// GTLRCloudRedis_DatabaseResourceSignalData.signalType +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeDatabaseAuditingDisabled = @"SIGNAL_TYPE_DATABASE_AUDITING_DISABLED"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeExposedToPublicAccess = @"SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeNoRootPassword = @"SIGNAL_TYPE_NO_ROOT_PASSWORD"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeOutdatedMinorVersion = @"SIGNAL_TYPE_OUTDATED_MINOR_VERSION"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeUnencryptedConnections = @"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"; +NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeUnspecified = @"SIGNAL_TYPE_UNSPECIFIED"; + // GTLRCloudRedis_EncryptionInfo.encryptionType NSString * const kGTLRCloudRedis_EncryptionInfo_EncryptionType_CustomerManagedEncryption = @"CUSTOMER_MANAGED_ENCRYPTION"; NSString * const kGTLRCloudRedis_EncryptionInfo_EncryptionType_GoogleDefaultEncryption = @"GOOGLE_DEFAULT_ENCRYPTION"; @@ -991,9 +1006,10 @@ @implementation GTLRCloudRedis_CustomMetadataData // @implementation GTLRCloudRedis_DatabaseResourceFeed -@dynamic backupdrMetadata, configBasedSignalData, feedTimestamp, feedType, - observabilityMetricData, recommendationSignalData, - resourceHealthSignalData, resourceId, resourceMetadata, skipIngestion; +@dynamic backupdrMetadata, configBasedSignalData, databaseResourceSignalData, + feedTimestamp, feedType, observabilityMetricData, + recommendationSignalData, resourceHealthSignalData, resourceId, + resourceMetadata, skipIngestion; @end @@ -1056,10 +1072,14 @@ @implementation GTLRCloudRedis_DatabaseResourceMetadata entitlements, expectedState, gcbdrConfiguration, identifier, instanceType, location, machineConfiguration, primaryResourceId, primaryResourceLocation, product, resourceContainer, resourceName, - suspensionReason, tagsSet, updationTime, userLabelSet; + suspensionReason, tagsSet, updationTime, userLabelSet, zoneProperty; + (NSDictionary *)propertyToJSONKeyMap { - return @{ @"identifier" : @"id" }; + NSDictionary *map = @{ + @"identifier" : @"id", + @"zoneProperty" : @"zone" + }; + return map; } + (NSDictionary *)arrayPropertyToClassMap { @@ -1097,6 +1117,17 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudRedis_DatabaseResourceSignalData +// + +@implementation GTLRCloudRedis_DatabaseResourceSignalData +@dynamic fullResourceName, lastRefreshTime, resourceId, signalBoolValue, + signalState, signalType; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudRedis_DiscoveryEndpoint diff --git a/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisObjects.h b/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisObjects.h index d4f23e095..e7f717b58 100644 --- a/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisObjects.h +++ b/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisObjects.h @@ -44,6 +44,7 @@ @class GTLRCloudRedis_DatabaseResourceMetadata; @class GTLRCloudRedis_DatabaseResourceRecommendationSignalData; @class GTLRCloudRedis_DatabaseResourceRecommendationSignalData_AdditionalMetadata; +@class GTLRCloudRedis_DatabaseResourceSignalData; @class GTLRCloudRedis_DiscoveryEndpoint; @class GTLRCloudRedis_EncryptionInfo; @class GTLRCloudRedis_Entitlement; @@ -580,6 +581,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType * Value: "CONFIG_BASED_SIGNAL_DATA" */ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_ConfigBasedSignalData; +/** + * Database resource signal data + * + * Value: "DATABASE_RESOURCE_SIGNAL_DATA" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_DatabaseResourceSignalData; /** Value: "FEEDTYPE_UNSPECIFIED" */ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceFeed_FeedType_FeedtypeUnspecified; /** @@ -2386,6 +2393,76 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceRecommendatio */ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceRecommendationSignalData_SignalType_SignalTypeWeakRootPassword; +// ---------------------------------------------------------------------------- +// GTLRCloudRedis_DatabaseResourceSignalData.signalState + +/** + * Signal is active and requires attention. + * + * Value: "ACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Active; +/** + * Signal is dismissed by the user and should not be shown to the user again. + * + * Value: "DISMISSED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Dismissed; +/** + * Signal is inactive and does not require attention. + * + * Value: "INACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Inactive; +/** + * Unspecified signal state. + * + * Value: "SIGNAL_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_SignalStateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRCloudRedis_DatabaseResourceSignalData.signalType + +/** + * Represents database auditing is disabled. + * + * Value: "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeDatabaseAuditingDisabled; +/** + * Represents if a resource is exposed to public access. + * + * Value: "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeExposedToPublicAccess; +/** + * Represents if a database has a password configured for the root account or + * not. + * + * Value: "SIGNAL_TYPE_NO_ROOT_PASSWORD" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeNoRootPassword; +/** + * Outdated Minor Version + * + * Value: "SIGNAL_TYPE_OUTDATED_MINOR_VERSION" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeOutdatedMinorVersion; +/** + * Represents if a resources requires all incoming connections to use SSL or + * not. + * + * Value: "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeUnencryptedConnections; +/** + * Unspecified signal type. + * + * Value: "SIGNAL_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeUnspecified; + // ---------------------------------------------------------------------------- // GTLRCloudRedis_EncryptionInfo.encryptionType @@ -4534,7 +4611,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_ZoneDistributionConfig_Mode_Z /** * DatabaseResourceFeed is the top level proto to be used to ingest different - * database resource level events into Condor platform. Next ID: 11 + * database resource level events into Condor platform. Next ID: 13 */ @interface GTLRCloudRedis_DatabaseResourceFeed : GTLRObject @@ -4547,6 +4624,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_ZoneDistributionConfig_Mode_Z */ @property(nonatomic, strong, nullable) GTLRCloudRedis_ConfigBasedSignalData *configBasedSignalData; +/** + * Database resource signal data is used to ingest signals from database + * resource signal feeds. + */ +@property(nonatomic, strong, nullable) GTLRCloudRedis_DatabaseResourceSignalData *databaseResourceSignalData; + /** Required. Timestamp when feed is generated. */ @property(nonatomic, strong, nullable) GTLRDateTime *feedTimestamp; @@ -4558,6 +4641,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_ZoneDistributionConfig_Mode_Z * Database resource metadata from BackupDR (Value: "BACKUPDR_METADATA") * @arg @c kGTLRCloudRedis_DatabaseResourceFeed_FeedType_ConfigBasedSignalData * Database config based signal data (Value: "CONFIG_BASED_SIGNAL_DATA") + * @arg @c kGTLRCloudRedis_DatabaseResourceFeed_FeedType_DatabaseResourceSignalData + * Database resource signal data (Value: "DATABASE_RESOURCE_SIGNAL_DATA") * @arg @c kGTLRCloudRedis_DatabaseResourceFeed_FeedType_FeedtypeUnspecified * Value "FEEDTYPE_UNSPECIFIED" * @arg @c kGTLRCloudRedis_DatabaseResourceFeed_FeedType_ObservabilityData @@ -5181,7 +5266,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_ZoneDistributionConfig_Mode_Z /** - * Common model for database resource instance metadata. Next ID: 26 + * Common model for database resource instance metadata. Next ID: 27 */ @interface GTLRCloudRedis_DatabaseResourceMetadata : GTLRObject @@ -5388,6 +5473,14 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_ZoneDistributionConfig_Mode_Z /** User-provided labels associated with the resource */ @property(nonatomic, strong, nullable) GTLRCloudRedis_UserLabels *userLabelSet; +/** + * The resource zone. This is only applicable for zonal resources and will be + * empty for regional and multi-regional resources. + * + * Remapped to 'zoneProperty' to avoid NSObject's 'zone'. + */ +@property(nonatomic, copy, nullable) NSString *zoneProperty; + @end @@ -5818,6 +5911,71 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRedis_ZoneDistributionConfig_Mode_Z @end +/** + * Database resource signal data. This is used to send signals to Condor which + * are based on the DB/Instance/Fleet level configurations. These will be used + * to send signals for all inventory types. Next ID: 7 + */ +@interface GTLRCloudRedis_DatabaseResourceSignalData : GTLRObject + +/** Required. Full Resource name of the source resource. */ +@property(nonatomic, copy, nullable) NSString *fullResourceName; + +/** Required. Last time signal was refreshed */ +@property(nonatomic, strong, nullable) GTLRDateTime *lastRefreshTime; + +/** Database resource id. */ +@property(nonatomic, strong, nullable) GTLRCloudRedis_DatabaseResourceId *resourceId; + +/** + * Signal data for boolean signals. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *signalBoolValue; + +/** + * Required. Output only. Signal state of the signal + * + * Likely values: + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Active + * Signal is active and requires attention. (Value: "ACTIVE") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Dismissed + * Signal is dismissed by the user and should not be shown to the user + * again. (Value: "DISMISSED") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_Inactive + * Signal is inactive and does not require attention. (Value: "INACTIVE") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalState_SignalStateUnspecified + * Unspecified signal state. (Value: "SIGNAL_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *signalState; + +/** + * Required. Signal type of the signal + * + * Likely values: + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeDatabaseAuditingDisabled + * Represents database auditing is disabled. (Value: + * "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeExposedToPublicAccess + * Represents if a resource is exposed to public access. (Value: + * "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeNoRootPassword + * Represents if a database has a password configured for the root + * account or not. (Value: "SIGNAL_TYPE_NO_ROOT_PASSWORD") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeOutdatedMinorVersion + * Outdated Minor Version (Value: "SIGNAL_TYPE_OUTDATED_MINOR_VERSION") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeUnencryptedConnections + * Represents if a resources requires all incoming connections to use SSL + * or not. (Value: "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS") + * @arg @c kGTLRCloudRedis_DatabaseResourceSignalData_SignalType_SignalTypeUnspecified + * Unspecified signal type. (Value: "SIGNAL_TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *signalType; + +@end + + /** * Endpoints on each network, for Redis clients to connect to the cluster. */ diff --git a/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisQuery.h b/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisQuery.h index 4aee54de6..309acf631 100644 --- a/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisQuery.h +++ b/Sources/GeneratedServices/CloudRedis/Public/GoogleAPIClientForREST/GTLRCloudRedisQuery.h @@ -1133,8 +1133,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCloudRedisQuery_ProjectsLocationsList : GTLRCloudRedisQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailObjects.m b/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailObjects.m index 9862f1480..8b6c6f572 100644 --- a/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailObjects.m +++ b/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailObjects.m @@ -143,6 +143,17 @@ NSString * const kGTLRCloudRetail_GoogleCloudRetailV2Control_SolutionTypes_SolutionTypeSearch = @"SOLUTION_TYPE_SEARCH"; NSString * const kGTLRCloudRetail_GoogleCloudRetailV2Control_SolutionTypes_SolutionTypeUnspecified = @"SOLUTION_TYPE_UNSPECIFIED"; +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec.conversationalFilteringMode +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_ConversationalFilterOnly = @"CONVERSATIONAL_FILTER_ONLY"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_Disabled = @"DISABLED"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_Enabled = @"ENABLED"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_ModeUnspecified = @"MODE_UNSPECIFIED"; + +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse.state +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_Streaming = @"STREAMING"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_Succeeded = @"SUCCEEDED"; + // GTLRCloudRetail_GoogleCloudRetailV2ImportProductsRequest.reconciliationMode NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ImportProductsRequest_ReconciliationMode_Full = @"FULL"; NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ImportProductsRequest_ReconciliationMode_Incremental = @"INCREMENTAL"; @@ -203,6 +214,27 @@ NSString * const kGTLRCloudRetail_GoogleCloudRetailV2RejoinUserEventsRequest_UserEventRejoinScope_UnjoinedEvents = @"UNJOINED_EVENTS"; NSString * const kGTLRCloudRetail_GoogleCloudRetailV2RejoinUserEventsRequest_UserEventRejoinScope_UserEventRejoinScopeUnspecified = @"USER_EVENT_REJOIN_SCOPE_UNSPECIFIED"; +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting.category +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryCivicIntegrity = @"HARM_CATEGORY_CIVIC_INTEGRITY"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryDangerousContent = @"HARM_CATEGORY_DANGEROUS_CONTENT"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryHarassment = @"HARM_CATEGORY_HARASSMENT"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryHateSpeech = @"HARM_CATEGORY_HATE_SPEECH"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategorySexuallyExplicit = @"HARM_CATEGORY_SEXUALLY_EXPLICIT"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryUnspecified = @"HARM_CATEGORY_UNSPECIFIED"; + +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting.method +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_HarmBlockMethodUnspecified = @"HARM_BLOCK_METHOD_UNSPECIFIED"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_Probability = @"PROBABILITY"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_Severity = @"SEVERITY"; + +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting.threshold +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockLowAndAbove = @"BLOCK_LOW_AND_ABOVE"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockMediumAndAbove = @"BLOCK_MEDIUM_AND_ABOVE"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockNone = @"BLOCK_NONE"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockOnlyHigh = @"BLOCK_ONLY_HIGH"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_HarmBlockThresholdUnspecified = @"HARM_BLOCK_THRESHOLD_UNSPECIFIED"; +NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_Off = @"OFF"; + // GTLRCloudRetail_GoogleCloudRetailV2SearchRequest.searchMode NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SearchRequest_SearchMode_FacetedSearchOnly = @"FACETED_SEARCH_ONLY"; NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SearchRequest_SearchMode_ProductSearchOnly = @"PRODUCT_SEARCH_ONLY"; @@ -1882,6 +1914,158 @@ @implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchCustomiza @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest +@dynamic branch, conversationalFilteringSpec, conversationId, pageCategories, + query, safetySettings, searchParams, userInfo, userLabels, visitorId; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"pageCategories" : [NSString class], + @"safetySettings" : [GTLRCloudRetail_GoogleCloudRetailV2SafetySetting class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest_UserLabels +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest_UserLabels + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec +@dynamic conversationalFilteringMode, enableConversationalFiltering, userAnswer; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestSearchParams +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestSearchParams +@dynamic boostSpec, canonicalFilter, filter, sortBy; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswer +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswer +@dynamic selectedAnswer, textAnswer; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer +@dynamic productAttributeValue; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse +@dynamic conversationalFilteringResult, conversationalTextResponse, + conversationId, followupQuestion, refinedSearch, state, userQueryTypes; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"refinedSearch" : [GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch class], + @"userQueryTypes" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult +@dynamic additionalFilter, followupQuestion; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter +@dynamic productAttributeValue; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion +@dynamic followupQuestion, suggestedAnswers; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"suggestedAnswers" : [GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer +@dynamic productAttributeValue; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch +@dynamic query; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudRetail_GoogleCloudRetailV2CreateModelMetadata @@ -3308,6 +3492,16 @@ @implementation GTLRCloudRetail_GoogleCloudRetailV2RuleTwowaySynonymsAction @end +// ---------------------------------------------------------------------------- +// +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting +// + +@implementation GTLRCloudRetail_GoogleCloudRetailV2SafetySetting +@dynamic category, method, threshold; +@end + + // ---------------------------------------------------------------------------- // // GTLRCloudRetail_GoogleCloudRetailV2SearchRequest diff --git a/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailQuery.m b/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailQuery.m index 2d0ecbd8b..05004795d 100644 --- a/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailQuery.m +++ b/Sources/GeneratedServices/CloudRetail/GTLRCloudRetailQuery.m @@ -1028,6 +1028,33 @@ + (instancetype)queryWithObject:(GTLRCloudRetail_GoogleCloudRetailV2Catalog *)ob @end +@implementation GTLRCloudRetailQuery_ProjectsLocationsCatalogsPlacementsConversationalSearch + +@dynamic placement; + ++ (instancetype)queryWithObject:(GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest *)object + placement:(NSString *)placement { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"placement" ]; + NSString *pathURITemplate = @"v2/{+placement}:conversationalSearch"; + GTLRCloudRetailQuery_ProjectsLocationsCatalogsPlacementsConversationalSearch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.placement = placement; + query.expectedObjectClass = [GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse class]; + query.loggingName = @"retail.projects.locations.catalogs.placements.conversationalSearch"; + return query; +} + +@end + @implementation GTLRCloudRetailQuery_ProjectsLocationsCatalogsPlacementsPredict @dynamic placement; @@ -1109,6 +1136,33 @@ + (instancetype)queryWithObject:(GTLRCloudRetail_GoogleCloudRetailV2AddControlRe @end +@implementation GTLRCloudRetailQuery_ProjectsLocationsCatalogsServingConfigsConversationalSearch + +@dynamic placement; + ++ (instancetype)queryWithObject:(GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest *)object + placement:(NSString *)placement { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"placement" ]; + NSString *pathURITemplate = @"v2/{+placement}:conversationalSearch"; + GTLRCloudRetailQuery_ProjectsLocationsCatalogsServingConfigsConversationalSearch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.placement = placement; + query.expectedObjectClass = [GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse class]; + query.loggingName = @"retail.projects.locations.catalogs.servingConfigs.conversationalSearch"; + return query; +} + +@end + @implementation GTLRCloudRetailQuery_ProjectsLocationsCatalogsServingConfigsCreate @dynamic parent, servingConfigId; diff --git a/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailObjects.h b/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailObjects.h index 96c1276fb..8c1e7f7de 100644 --- a/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailObjects.h +++ b/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailObjects.h @@ -71,6 +71,16 @@ @class GTLRCloudRetail_GoogleCloudRetailV2ConditionQueryTerm; @class GTLRCloudRetail_GoogleCloudRetailV2ConditionTimeRange; @class GTLRCloudRetail_GoogleCloudRetailV2Control; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest_UserLabels; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestSearchParams; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswer; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer; +@class GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch; @class GTLRCloudRetail_GoogleCloudRetailV2CustomAttribute; @class GTLRCloudRetail_GoogleCloudRetailV2DoubleList; @class GTLRCloudRetail_GoogleCloudRetailV2ExperimentInfo; @@ -133,6 +143,7 @@ @class GTLRCloudRetail_GoogleCloudRetailV2RuleRemoveFacetAction; @class GTLRCloudRetail_GoogleCloudRetailV2RuleReplacementAction; @class GTLRCloudRetail_GoogleCloudRetailV2RuleTwowaySynonymsAction; +@class GTLRCloudRetail_GoogleCloudRetailV2SafetySetting; @class GTLRCloudRetail_GoogleCloudRetailV2SearchRequest_Labels; @class GTLRCloudRetail_GoogleCloudRetailV2SearchRequest_UserAttributes; @class GTLRCloudRetail_GoogleCloudRetailV2SearchRequestBoostSpec; @@ -823,6 +834,56 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2Control_S */ FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2Control_SolutionTypes_SolutionTypeUnspecified; +// ---------------------------------------------------------------------------- +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec.conversationalFilteringMode + +/** + * Enables Conversational Filtering without Conversational Search. + * + * Value: "CONVERSATIONAL_FILTER_ONLY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_ConversationalFilterOnly; +/** + * Disables Conversational Filtering when using Conversational Search. + * + * Value: "DISABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_Disabled; +/** + * Enables Conversational Filtering when using Conversational Search. + * + * Value: "ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_Enabled; +/** + * Default value. + * + * Value: "MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_ModeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse.state + +/** + * Unknown. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_StateUnspecified; +/** + * Response generation is being streamed. + * + * Value: "STREAMING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_Streaming; +/** + * Response generation has succeeded. + * + * Value: "SUCCEEDED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_Succeeded; + // ---------------------------------------------------------------------------- // GTLRCloudRetail_GoogleCloudRetailV2ImportProductsRequest.reconciliationMode @@ -1113,6 +1174,108 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2RejoinUse */ FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2RejoinUserEventsRequest_UserEventRejoinScope_UserEventRejoinScopeUnspecified; +// ---------------------------------------------------------------------------- +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting.category + +/** + * The harm category is civic integrity. + * + * Value: "HARM_CATEGORY_CIVIC_INTEGRITY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryCivicIntegrity; +/** + * The harm category is dangerous content. + * + * Value: "HARM_CATEGORY_DANGEROUS_CONTENT" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryDangerousContent; +/** + * The harm category is harassment. + * + * Value: "HARM_CATEGORY_HARASSMENT" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryHarassment; +/** + * The harm category is hate speech. + * + * Value: "HARM_CATEGORY_HATE_SPEECH" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryHateSpeech; +/** + * The harm category is sexually explicit content. + * + * Value: "HARM_CATEGORY_SEXUALLY_EXPLICIT" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategorySexuallyExplicit; +/** + * The harm category is unspecified. + * + * Value: "HARM_CATEGORY_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting.method + +/** + * The harm block method is unspecified. + * + * Value: "HARM_BLOCK_METHOD_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_HarmBlockMethodUnspecified; +/** + * The harm block method uses the probability score. + * + * Value: "PROBABILITY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_Probability; +/** + * The harm block method uses both probability and severity scores. + * + * Value: "SEVERITY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_Severity; + +// ---------------------------------------------------------------------------- +// GTLRCloudRetail_GoogleCloudRetailV2SafetySetting.threshold + +/** + * Block low threshold and above (i.e. block more). + * + * Value: "BLOCK_LOW_AND_ABOVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockLowAndAbove; +/** + * Block medium threshold and above. + * + * Value: "BLOCK_MEDIUM_AND_ABOVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockMediumAndAbove; +/** + * Block none. + * + * Value: "BLOCK_NONE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockNone; +/** + * Block only high threshold (i.e. block less). + * + * Value: "BLOCK_ONLY_HIGH" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockOnlyHigh; +/** + * Unspecified harm block threshold. + * + * Value: "HARM_BLOCK_THRESHOLD_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_HarmBlockThresholdUnspecified; +/** + * Turn off the safety filter. + * + * Value: "OFF" + */ +FOUNDATION_EXTERN NSString * const kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_Off; + // ---------------------------------------------------------------------------- // GTLRCloudRetail_GoogleCloudRetailV2SearchRequest.searchMode @@ -4437,6 +4600,361 @@ GTLR_DEPRECATED @end +/** + * Request message for ConversationalSearchService.ConversationalSearch method. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest : GTLRObject + +/** + * Required. The branch resource name, such as `projects/ * + * /locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" + * as the branch ID or leave this field empty, to search products under the + * default branch. + */ +@property(nonatomic, copy, nullable) NSString *branch; + +/** + * Optional. This field specifies all conversational filtering related + * parameters. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec *conversationalFilteringSpec; + +/** + * Optional. This field specifies the conversation id, which maintains the + * state of the conversation between client side and server side. Use the value + * from the previous ConversationalSearchResponse.conversation_id. For the + * initial request, this should be empty. + */ +@property(nonatomic, copy, nullable) NSString *conversationId; + +/** + * Optional. The categories associated with a category page. Must be set for + * category navigation queries to achieve good search quality. The format + * should be the same as UserEvent.page_categories; To represent full path of + * category, use '>' sign to separate different hierarchies. If '>' is part of + * the category name, replace it with other character(s). Category pages + * include special pages such as sales or promotions. For instance, a special + * sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 + * Black Friday Deals"]. + */ +@property(nonatomic, strong, nullable) NSArray *pageCategories; + +/** + * Optional. Raw search query to be searched for. If this field is empty, the + * request is considered a category browsing request. + */ +@property(nonatomic, copy, nullable) NSString *query; + +/** Optional. The safety settings to be applied to the generated content. */ +@property(nonatomic, strong, nullable) NSArray *safetySettings; + +/** Optional. Search parameters. */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestSearchParams *searchParams; + +/** Optional. User information. */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2UserInfo *userInfo; + +/** + * Optional. The user labels applied to a resource must meet the following + * requirements: * Each resource can have multiple labels, up to a maximum of + * 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 + * character and a maximum length of 63 characters and cannot be empty. Values + * can be empty and have a maximum length of 63 characters. * Keys and values + * can contain only lowercase letters, numeric characters, underscores, and + * dashes. All characters must use UTF-8 encoding, and international characters + * are allowed. * The key portion of a label must be unique. However, you can + * use the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest_UserLabels *userLabels; + +/** + * Required. A unique identifier for tracking visitors. For example, this could + * be implemented with an HTTP cookie, which should be able to uniquely + * identify a visitor on a single device. This unique identifier should not + * change if the visitor logs in or out of the website. This should be the same + * identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string + * with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error + * is returned. + */ +@property(nonatomic, copy, nullable) NSString *visitorId; + +@end + + +/** + * Optional. The user labels applied to a resource must meet the following + * requirements: * Each resource can have multiple labels, up to a maximum of + * 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 + * character and a maximum length of 63 characters and cannot be empty. Values + * can be empty and have a maximum length of 63 characters. * Keys and values + * can contain only lowercase letters, numeric characters, underscores, and + * dashes. All characters must use UTF-8 encoding, and international characters + * are allowed. * The key portion of a label must be unique. However, you can + * use the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest_UserLabels : GTLRObject +@end + + +/** + * This field specifies all conversational filtering related parameters + * addition to conversational retail search. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec : GTLRObject + +/** + * Optional. Mode to control Conversational Filtering. Defaults to + * Mode.DISABLED if it's unset. + * + * Likely values: + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_ConversationalFilterOnly + * Enables Conversational Filtering without Conversational Search. + * (Value: "CONVERSATIONAL_FILTER_ONLY") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_Disabled + * Disables Conversational Filtering when using Conversational Search. + * (Value: "DISABLED") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_Enabled + * Enables Conversational Filtering when using Conversational Search. + * (Value: "ENABLED") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec_ConversationalFilteringMode_ModeUnspecified + * Default value. (Value: "MODE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *conversationalFilteringMode; + +/** + * Optional. This field is deprecated. Please use + * ConversationalFilteringSpec.conversational_filtering_mode instead. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableConversationalFiltering GTLR_DEPRECATED; + +/** + * Optional. This field specifies the current user answer during the + * conversational filtering search. It can be either user selected from + * suggested answers or user input plain text. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswer *userAnswer; + +@end + + +/** + * Search parameters. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestSearchParams : GTLRObject + +/** + * Optional. The boost spec to specify the boosting of search results. The + * syntax of the boost spec is the same as SearchRequest.boost_spec. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2SearchRequestBoostSpec *boostSpec; + +/** + * Optional. The canonical filter string to restrict search results. The syntax + * of the canonical filter string is the same as + * SearchRequest.canonical_filter. + */ +@property(nonatomic, copy, nullable) NSString *canonicalFilter; + +/** + * Optional. The filter string to restrict search results. The syntax of the + * filter string is the same as SearchRequest.filter. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. The sort string to specify the sorting of search results. The + * syntax of the sort string is the same as SearchRequest.sort. + */ +@property(nonatomic, copy, nullable) NSString *sortBy; + +@end + + +/** + * This field specifies the current user answer during the conversational + * filtering search. This can be either user selected from suggested answers or + * user input plain text. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswer : GTLRObject + +/** + * Optional. This field specifies the selected answer during the conversational + * search. This should be a subset of + * ConversationalSearchResponse.followup_question.suggested_answers. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer *selectedAnswer; + +/** + * This field specifies the incremental input text from the user during the + * conversational search. + */ +@property(nonatomic, copy, nullable) NSString *textAnswer; + +@end + + +/** + * This field specifies the selected answers during the conversational search. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer : GTLRObject + +/** + * Optional. This field specifies the selected answer which is a attribute + * key-value. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ProductAttributeValue *productAttributeValue; + +@end + + +/** + * Response message for ConversationalSearchService.ConversationalSearch + * method. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse : GTLRObject + +/** + * This field specifies all related information that is needed on client side + * for UI rendering of conversational filtering search. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult *conversationalFilteringResult; + +/** The conversational answer-based text response generated by the Server. */ +@property(nonatomic, copy, nullable) NSString *conversationalTextResponse; + +/** + * Conversation UUID. This field will be stored in client side storage to + * maintain the conversation session with server and will be used for next + * search request's ConversationalSearchRequest.conversation_id to restore + * conversation state in server. + */ +@property(nonatomic, copy, nullable) NSString *conversationId; + +/** The conversational followup question generated for Intent refinement. */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion *followupQuestion; + +/** + * The proposed refined search queries. They can be used to fetch the relevant + * search results. When using CONVERSATIONAL_FILTER_ONLY mode, the + * refined_query from search response will be populated here. + */ +@property(nonatomic, strong, nullable) NSArray *refinedSearch; + +/** + * Output only. The state of the response generation. + * + * Likely values: + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_StateUnspecified + * Unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_Streaming + * Response generation is being streamed. (Value: "STREAMING") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse_State_Succeeded + * Response generation has succeeded. (Value: "SUCCEEDED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** + * The types Retail classifies the search query as. Supported values are: - + * "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - + * "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - + * "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - + * "DISABLED" + */ +@property(nonatomic, strong, nullable) NSArray *userQueryTypes; + +@end + + +/** + * This field specifies all related information that is needed on client side + * for UI rendering of conversational filtering search. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult : GTLRObject + +/** + * This is the incremental additional filters implied from the current user + * answer. User should add the suggested addition filters to the previous + * ConversationalSearchRequest.search_params.filter and SearchRequest.filter, + * and use the merged filter in the follow up requests. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter *additionalFilter; + +/** The conversational filtering question. */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion *followupQuestion; + +@end + + +/** + * Additional filter that client side need to apply. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter : GTLRObject + +/** + * Product attribute value, including an attribute key and an attribute value. + * Other types can be added here in the future. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ProductAttributeValue *productAttributeValue; + +@end + + +/** + * The conversational followup question generated for Intent refinement. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion : GTLRObject + +/** The conversational followup question generated for Intent refinement. */ +@property(nonatomic, copy, nullable) NSString *followupQuestion; + +/** The answer options provided to client for the follow-up question. */ +@property(nonatomic, strong, nullable) NSArray *suggestedAnswers; + +@end + + +/** + * Suggested answers to the follow-up question. If it's numerical attribute, + * only ProductAttributeInterval will be set. If it's textual attribute, only + * productAttributeValue will be set. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer : GTLRObject + +/** + * Product attribute value, including an attribute key and an attribute value. + * Other types can be added here in the future. + */ +@property(nonatomic, strong, nullable) GTLRCloudRetail_GoogleCloudRetailV2ProductAttributeValue *productAttributeValue; + +@end + + +/** + * The proposed refined search for intent-refinement/bundled shopping + * conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query + * from search response will be populated here. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch : GTLRObject + +/** The query to be used for search. */ +@property(nonatomic, copy, nullable) NSString *query; + +@end + + /** * Metadata associated with a create operation. */ @@ -7506,6 +8024,75 @@ GTLR_DEPRECATED @end +/** + * Safety settings. + */ +@interface GTLRCloudRetail_GoogleCloudRetailV2SafetySetting : GTLRObject + +/** + * Harm category. + * + * Likely values: + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryCivicIntegrity + * The harm category is civic integrity. (Value: + * "HARM_CATEGORY_CIVIC_INTEGRITY") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryDangerousContent + * The harm category is dangerous content. (Value: + * "HARM_CATEGORY_DANGEROUS_CONTENT") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryHarassment + * The harm category is harassment. (Value: "HARM_CATEGORY_HARASSMENT") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryHateSpeech + * The harm category is hate speech. (Value: "HARM_CATEGORY_HATE_SPEECH") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategorySexuallyExplicit + * The harm category is sexually explicit content. (Value: + * "HARM_CATEGORY_SEXUALLY_EXPLICIT") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Category_HarmCategoryUnspecified + * The harm category is unspecified. (Value: "HARM_CATEGORY_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *category; + +/** + * Optional. Specify if the threshold is used for probability or severity + * score. If not specified, the threshold is used for probability score. + * + * Likely values: + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_HarmBlockMethodUnspecified + * The harm block method is unspecified. (Value: + * "HARM_BLOCK_METHOD_UNSPECIFIED") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_Probability + * The harm block method uses the probability score. (Value: + * "PROBABILITY") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Method_Severity + * The harm block method uses both probability and severity scores. + * (Value: "SEVERITY") + */ +@property(nonatomic, copy, nullable) NSString *method; + +/** + * The harm block threshold. + * + * Likely values: + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockLowAndAbove + * Block low threshold and above (i.e. block more). (Value: + * "BLOCK_LOW_AND_ABOVE") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockMediumAndAbove + * Block medium threshold and above. (Value: "BLOCK_MEDIUM_AND_ABOVE") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockNone + * Block none. (Value: "BLOCK_NONE") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_BlockOnlyHigh + * Block only high threshold (i.e. block less). (Value: + * "BLOCK_ONLY_HIGH") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_HarmBlockThresholdUnspecified + * Unspecified harm block threshold. (Value: + * "HARM_BLOCK_THRESHOLD_UNSPECIFIED") + * @arg @c kGTLRCloudRetail_GoogleCloudRetailV2SafetySetting_Threshold_Off + * Turn off the safety filter. (Value: "OFF") + */ +@property(nonatomic, copy, nullable) NSString *threshold; + +@end + + /** * Request message for SearchService.Search method. */ diff --git a/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailQuery.h b/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailQuery.h index 6a7e6eaf6..016226554 100644 --- a/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailQuery.h +++ b/Sources/GeneratedServices/CloudRetail/Public/GoogleAPIClientForREST/GTLRCloudRetailQuery.h @@ -1933,6 +1933,53 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Performs a conversational search. This feature is only available for users + * who have Conversational Search enabled. + * + * Method: retail.projects.locations.catalogs.placements.conversationalSearch + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudRetailCloudPlatform + */ +@interface GTLRCloudRetailQuery_ProjectsLocationsCatalogsPlacementsConversationalSearch : GTLRCloudRetailQuery + +/** + * Required. The resource name of the search engine placement, such as + * `projects/ * + * /locations/global/catalogs/default_catalog/placements/default_search` or + * `projects/ * + * /locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` + * This field is used to identify the serving config name and the set of models + * that will be used to make the search. + */ +@property(nonatomic, copy, nullable) NSString *placement; + +/** + * Fetches a @c + * GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse. + * + * Performs a conversational search. This feature is only available for users + * who have Conversational Search enabled. + * + * @param object The @c + * GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest to include + * in the query. + * @param placement Required. The resource name of the search engine placement, + * such as `projects/ * + * /locations/global/catalogs/default_catalog/placements/default_search` or + * `projects/ * + * /locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` + * This field is used to identify the serving config name and the set of + * models that will be used to make the search. + * + * @return GTLRCloudRetailQuery_ProjectsLocationsCatalogsPlacementsConversationalSearch + */ ++ (instancetype)queryWithObject:(GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest *)object + placement:(NSString *)placement; + +@end + /** * Makes a recommendation prediction. * @@ -2078,6 +2125,53 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Performs a conversational search. This feature is only available for users + * who have Conversational Search enabled. + * + * Method: retail.projects.locations.catalogs.servingConfigs.conversationalSearch + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudRetailCloudPlatform + */ +@interface GTLRCloudRetailQuery_ProjectsLocationsCatalogsServingConfigsConversationalSearch : GTLRCloudRetailQuery + +/** + * Required. The resource name of the search engine placement, such as + * `projects/ * + * /locations/global/catalogs/default_catalog/placements/default_search` or + * `projects/ * + * /locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` + * This field is used to identify the serving config name and the set of models + * that will be used to make the search. + */ +@property(nonatomic, copy, nullable) NSString *placement; + +/** + * Fetches a @c + * GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchResponse. + * + * Performs a conversational search. This feature is only available for users + * who have Conversational Search enabled. + * + * @param object The @c + * GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest to include + * in the query. + * @param placement Required. The resource name of the search engine placement, + * such as `projects/ * + * /locations/global/catalogs/default_catalog/placements/default_search` or + * `projects/ * + * /locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` + * This field is used to identify the serving config name and the set of + * models that will be used to make the search. + * + * @return GTLRCloudRetailQuery_ProjectsLocationsCatalogsServingConfigsConversationalSearch + */ ++ (instancetype)queryWithObject:(GTLRCloudRetail_GoogleCloudRetailV2ConversationalSearchRequest *)object + placement:(NSString *)placement; + +@end + /** * Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a * Catalog, otherwise a FAILED_PRECONDITION error is returned. diff --git a/Sources/GeneratedServices/CloudRun/GTLRCloudRunObjects.m b/Sources/GeneratedServices/CloudRun/GTLRCloudRunObjects.m index 7bb4bc785..2a0b15bf5 100644 --- a/Sources/GeneratedServices/CloudRun/GTLRCloudRunObjects.m +++ b/Sources/GeneratedServices/CloudRun/GTLRCloudRunObjects.m @@ -1368,8 +1368,8 @@ @implementation GTLRCloudRun_GoogleCloudRunV2StorageSource // @implementation GTLRCloudRun_GoogleCloudRunV2SubmitBuildRequest -@dynamic buildpackBuild, dockerBuild, imageUri, machineType, releaseTrack, - serviceAccount, storageSource, tags, workerPool; +@dynamic buildpackBuild, client, dockerBuild, imageUri, machineType, + releaseTrack, serviceAccount, storageSource, tags, workerPool; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -2450,11 +2450,12 @@ @implementation GTLRCloudRun_GoogleIamV1TestIamPermissionsResponse // @implementation GTLRCloudRun_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudRun_GoogleLongrunningOperation class] + @"operations" : [GTLRCloudRun_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudRun/GTLRCloudRunQuery.m b/Sources/GeneratedServices/CloudRun/GTLRCloudRunQuery.m index 87d506e3a..7651292ed 100644 --- a/Sources/GeneratedServices/CloudRun/GTLRCloudRunQuery.m +++ b/Sources/GeneratedServices/CloudRun/GTLRCloudRunQuery.m @@ -538,7 +538,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudRunQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunObjects.h b/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunObjects.h index ac495014c..2fccac51f 100644 --- a/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunObjects.h +++ b/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunObjects.h @@ -4641,9 +4641,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRun_GoogleIamV1AuditLogConfig_LogTy @property(nonatomic, strong, nullable) GTLRCloudRun_GoogleCloudRunV2MultiRegionSettings *multiRegionSettings; /** - * The fully qualified name of this Service. In CreateServiceRequest, this - * field is ignored, and instead composed from CreateServiceRequest.parent and - * CreateServiceRequest.service_id. Format: + * Identifier. The fully qualified name of this Service. In + * CreateServiceRequest, this field is ignored, and instead composed from + * CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: * projects/{project}/locations/{location}/services/{service_id} */ @property(nonatomic, copy, nullable) NSString *name; @@ -4893,6 +4893,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRun_GoogleIamV1AuditLogConfig_LogTy /** Build the source using Buildpacks. */ @property(nonatomic, strong, nullable) GTLRCloudRun_GoogleCloudRunV2BuildpacksBuild *buildpackBuild; +/** Optional. The client that initiated the build request. */ +@property(nonatomic, copy, nullable) NSString *client; + /** Build the source using Docker. This means the source has a Dockerfile. */ @property(nonatomic, strong, nullable) GTLRCloudRun_GoogleCloudRunV2DockerBuild *dockerBuild; @@ -8173,6 +8176,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudRun_GoogleIamV1AuditLogConfig_LogTy */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunQuery.h b/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunQuery.h index 7950a7d15..4d102d9a7 100644 --- a/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunQuery.h +++ b/Sources/GeneratedServices/CloudRun/Public/GoogleAPIClientForREST/GTLRCloudRunQuery.h @@ -991,6 +991,17 @@ NS_ASSUME_NONNULL_BEGIN */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudRun_GoogleLongrunningListOperationsResponse. * @@ -1300,9 +1311,9 @@ NS_ASSUME_NONNULL_BEGIN @property(nonatomic, assign) BOOL allowMissing; /** - * The fully qualified name of this Service. In CreateServiceRequest, this - * field is ignored, and instead composed from CreateServiceRequest.parent and - * CreateServiceRequest.service_id. Format: + * Identifier. The fully qualified name of this Service. In + * CreateServiceRequest, this field is ignored, and instead composed from + * CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: * projects/{project}/locations/{location}/services/{service_id} */ @property(nonatomic, copy, nullable) NSString *name; @@ -1327,7 +1338,7 @@ NS_ASSUME_NONNULL_BEGIN * * @param object The @c GTLRCloudRun_GoogleCloudRunV2Service to include in the * query. - * @param name The fully qualified name of this Service. In + * @param name Identifier. The fully qualified name of this Service. In * CreateServiceRequest, this field is ignored, and instead composed from * CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: * projects/{project}/locations/{location}/services/{service_id} diff --git a/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerObjects.m b/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerObjects.m index 3d76a92ab..4789bc669 100644 --- a/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerObjects.m +++ b/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerObjects.m @@ -183,11 +183,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRCloudScheduler_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudScheduler_Operation class] + @"operations" : [GTLRCloudScheduler_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerQuery.m b/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerQuery.m index 7cb97520b..f1a006195 100644 --- a/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerQuery.m +++ b/Sources/GeneratedServices/CloudScheduler/GTLRCloudSchedulerQuery.m @@ -16,90 +16,6 @@ @implementation GTLRCloudSchedulerQuery @end -@implementation GTLRCloudSchedulerQuery_OperationsCancel - -@dynamic name; - -+ (instancetype)queryWithObject:(GTLRCloudScheduler_CancelOperationRequest *)object - name:(NSString *)name { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}:cancel"; - GTLRCloudSchedulerQuery_OperationsCancel *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.name = name; - query.expectedObjectClass = [GTLRCloudScheduler_Empty class]; - query.loggingName = @"cloudscheduler.operations.cancel"; - return query; -} - -@end - -@implementation GTLRCloudSchedulerQuery_OperationsDelete - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRCloudSchedulerQuery_OperationsDelete *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"DELETE" - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRCloudScheduler_Empty class]; - query.loggingName = @"cloudscheduler.operations.delete"; - return query; -} - -@end - -@implementation GTLRCloudSchedulerQuery_OperationsGet - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRCloudSchedulerQuery_OperationsGet *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRCloudScheduler_Operation class]; - query.loggingName = @"cloudscheduler.operations.get"; - return query; -} - -@end - -@implementation GTLRCloudSchedulerQuery_OperationsList - -@dynamic filter, name, pageSize, pageToken; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRCloudSchedulerQuery_OperationsList *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRCloudScheduler_ListOperationsResponse class]; - query.loggingName = @"cloudscheduler.operations.list"; - return query; -} - -@end - @implementation GTLRCloudSchedulerQuery_ProjectsLocationsGet @dynamic name; @@ -336,3 +252,87 @@ + (instancetype)queryWithName:(NSString *)name { } @end + +@implementation GTLRCloudSchedulerQuery_ProjectsLocationsOperationsCancel + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLRCloudScheduler_CancelOperationRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:cancel"; + GTLRCloudSchedulerQuery_ProjectsLocationsOperationsCancel *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRCloudScheduler_Empty class]; + query.loggingName = @"cloudscheduler.projects.locations.operations.cancel"; + return query; +} + +@end + +@implementation GTLRCloudSchedulerQuery_ProjectsLocationsOperationsDelete + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRCloudSchedulerQuery_ProjectsLocationsOperationsDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRCloudScheduler_Empty class]; + query.loggingName = @"cloudscheduler.projects.locations.operations.delete"; + return query; +} + +@end + +@implementation GTLRCloudSchedulerQuery_ProjectsLocationsOperationsGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRCloudSchedulerQuery_ProjectsLocationsOperationsGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRCloudScheduler_Operation class]; + query.loggingName = @"cloudscheduler.projects.locations.operations.get"; + return query; +} + +@end + +@implementation GTLRCloudSchedulerQuery_ProjectsLocationsOperationsList + +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}/operations"; + GTLRCloudSchedulerQuery_ProjectsLocationsOperationsList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRCloudScheduler_ListOperationsResponse class]; + query.loggingName = @"cloudscheduler.projects.locations.operations.list"; + return query; +} + +@end diff --git a/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerObjects.h b/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerObjects.h index 321c6d8e9..ac483ada0 100644 --- a/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerObjects.h +++ b/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerObjects.h @@ -731,6 +731,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudScheduler_Job_State_UpdateFailed; */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerQuery.h b/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerQuery.h index 0b1703111..1af0ecddb 100644 --- a/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerQuery.h +++ b/Sources/GeneratedServices/CloudScheduler/Public/GoogleAPIClientForREST/GTLRCloudSchedulerQuery.h @@ -33,142 +33,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Starts asynchronous cancellation on a long-running operation. The server - * makes a best effort to cancel the operation, but success is not guaranteed. - * If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or - * other methods to check whether the cancellation succeeded or whether the - * operation completed despite cancellation. On successful cancellation, the - * operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of `1`, corresponding to - * `Code.CANCELLED`. - * - * Method: cloudscheduler.operations.cancel - */ -@interface GTLRCloudSchedulerQuery_OperationsCancel : GTLRCloudSchedulerQuery - -/** The name of the operation resource to be cancelled. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRCloudScheduler_Empty. - * - * Starts asynchronous cancellation on a long-running operation. The server - * makes a best effort to cancel the operation, but success is not guaranteed. - * If the server doesn't support this method, it returns - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or - * other methods to check whether the cancellation succeeded or whether the - * operation completed despite cancellation. On successful cancellation, the - * operation is not deleted; instead, it becomes an operation with an - * Operation.error value with a google.rpc.Status.code of `1`, corresponding to - * `Code.CANCELLED`. - * - * @param object The @c GTLRCloudScheduler_CancelOperationRequest to include in - * the query. - * @param name The name of the operation resource to be cancelled. - * - * @return GTLRCloudSchedulerQuery_OperationsCancel - */ -+ (instancetype)queryWithObject:(GTLRCloudScheduler_CancelOperationRequest *)object - name:(NSString *)name; - -@end - -/** - * 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`. - * - * Method: cloudscheduler.operations.delete - */ -@interface GTLRCloudSchedulerQuery_OperationsDelete : GTLRCloudSchedulerQuery - -/** The name of the operation resource to be deleted. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRCloudScheduler_Empty. - * - * 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`. - * - * @param name The name of the operation resource to be deleted. - * - * @return GTLRCloudSchedulerQuery_OperationsDelete - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * 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. - * - * Method: cloudscheduler.operations.get - */ -@interface GTLRCloudSchedulerQuery_OperationsGet : GTLRCloudSchedulerQuery - -/** The name of the operation resource. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRCloudScheduler_Operation. - * - * 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. - * - * @param name The name of the operation resource. - * - * @return GTLRCloudSchedulerQuery_OperationsGet - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * Lists operations that match the specified filter in the request. If the - * server doesn't support this method, it returns `UNIMPLEMENTED`. - * - * Method: cloudscheduler.operations.list - */ -@interface GTLRCloudSchedulerQuery_OperationsList : GTLRCloudSchedulerQuery - -/** The standard list filter. */ -@property(nonatomic, copy, nullable) NSString *filter; - -/** The name of the operation's parent resource. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** The standard list page size. */ -@property(nonatomic, assign) NSInteger pageSize; - -/** The standard list page token. */ -@property(nonatomic, copy, nullable) NSString *pageToken; - -/** - * Fetches a @c GTLRCloudScheduler_ListOperationsResponse. - * - * Lists operations that match the specified filter in the request. If the - * server doesn't support this method, it returns `UNIMPLEMENTED`. - * - * @param name The name of the operation's parent resource. - * - * @return GTLRCloudSchedulerQuery_OperationsList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - /** * Gets information about a location. * @@ -525,8 +389,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCloudSchedulerQuery_ProjectsLocationsList : GTLRCloudSchedulerQuery /** - * Optional. A list of extra location types that should be used as conditions - * for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -569,6 +433,165 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Starts asynchronous cancellation on a long-running operation. The server + * makes a best effort to cancel the operation, but success is not guaranteed. + * If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or + * other methods to check whether the cancellation succeeded or whether the + * operation completed despite cancellation. On successful cancellation, the + * operation is not deleted; instead, it becomes an operation with an + * Operation.error value with a google.rpc.Status.code of `1`, corresponding to + * `Code.CANCELLED`. + * + * Method: cloudscheduler.projects.locations.operations.cancel + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudSchedulerCloudPlatform + */ +@interface GTLRCloudSchedulerQuery_ProjectsLocationsOperationsCancel : GTLRCloudSchedulerQuery + +/** The name of the operation resource to be cancelled. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRCloudScheduler_Empty. + * + * Starts asynchronous cancellation on a long-running operation. The server + * makes a best effort to cancel the operation, but success is not guaranteed. + * If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or + * other methods to check whether the cancellation succeeded or whether the + * operation completed despite cancellation. On successful cancellation, the + * operation is not deleted; instead, it becomes an operation with an + * Operation.error value with a google.rpc.Status.code of `1`, corresponding to + * `Code.CANCELLED`. + * + * @param object The @c GTLRCloudScheduler_CancelOperationRequest to include in + * the query. + * @param name The name of the operation resource to be cancelled. + * + * @return GTLRCloudSchedulerQuery_ProjectsLocationsOperationsCancel + */ ++ (instancetype)queryWithObject:(GTLRCloudScheduler_CancelOperationRequest *)object + name:(NSString *)name; + +@end + +/** + * 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`. + * + * Method: cloudscheduler.projects.locations.operations.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudSchedulerCloudPlatform + */ +@interface GTLRCloudSchedulerQuery_ProjectsLocationsOperationsDelete : GTLRCloudSchedulerQuery + +/** The name of the operation resource to be deleted. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRCloudScheduler_Empty. + * + * 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`. + * + * @param name The name of the operation resource to be deleted. + * + * @return GTLRCloudSchedulerQuery_ProjectsLocationsOperationsDelete + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * 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. + * + * Method: cloudscheduler.projects.locations.operations.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudSchedulerCloudPlatform + */ +@interface GTLRCloudSchedulerQuery_ProjectsLocationsOperationsGet : GTLRCloudSchedulerQuery + +/** The name of the operation resource. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRCloudScheduler_Operation. + * + * 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. + * + * @param name The name of the operation resource. + * + * @return GTLRCloudSchedulerQuery_ProjectsLocationsOperationsGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Lists operations that match the specified filter in the request. If the + * server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * Method: cloudscheduler.projects.locations.operations.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeCloudSchedulerCloudPlatform + */ +@interface GTLRCloudSchedulerQuery_ProjectsLocationsOperationsList : GTLRCloudSchedulerQuery + +/** The standard list filter. */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** The name of the operation's parent resource. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** The standard list page size. */ +@property(nonatomic, assign) NSInteger pageSize; + +/** The standard list page token. */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + +/** + * Fetches a @c GTLRCloudScheduler_ListOperationsResponse. + * + * Lists operations that match the specified filter in the request. If the + * server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param name The name of the operation's parent resource. + * + * @return GTLRCloudSchedulerQuery_ProjectsLocationsOperationsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + NS_ASSUME_NONNULL_END #pragma clang diagnostic pop diff --git a/Sources/GeneratedServices/CloudShell/GTLRCloudShellObjects.m b/Sources/GeneratedServices/CloudShell/GTLRCloudShellObjects.m index 82a08bcec..0247fa699 100644 --- a/Sources/GeneratedServices/CloudShell/GTLRCloudShellObjects.m +++ b/Sources/GeneratedServices/CloudShell/GTLRCloudShellObjects.m @@ -150,11 +150,12 @@ @implementation GTLRCloudShell_Environment // @implementation GTLRCloudShell_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudShell_Operation class] + @"operations" : [GTLRCloudShell_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/CloudShell/GTLRCloudShellQuery.m b/Sources/GeneratedServices/CloudShell/GTLRCloudShellQuery.m index aa4f93d04..173d8b588 100644 --- a/Sources/GeneratedServices/CloudShell/GTLRCloudShellQuery.m +++ b/Sources/GeneratedServices/CloudShell/GTLRCloudShellQuery.m @@ -84,7 +84,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudShellQuery_OperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellObjects.h b/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellObjects.h index 8975fc0b9..2b770d94c 100644 --- a/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellObjects.h +++ b/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellObjects.h @@ -325,6 +325,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudShell_StartEnvironmentMetadata_Stat */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellQuery.h b/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellQuery.h index aca9016bb..3950f110c 100644 --- a/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellQuery.h +++ b/Sources/GeneratedServices/CloudShell/Public/GoogleAPIClientForREST/GTLRCloudShellQuery.h @@ -164,6 +164,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudShell_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksObjects.h b/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksObjects.h index 1e735b4f2..62eb11bba 100644 --- a/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksObjects.h +++ b/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksObjects.h @@ -337,15 +337,15 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasks_Task_View_ViewUnspecified; // GTLRCloudTasks_UriOverride.scheme /** - * Convert the scheme to HTTP, e.g., https://www.google.ca will change to - * http://www.google.ca. + * Convert the scheme to HTTP, e.g., "https://www.example.com" will change to + * "http://www.example.com". * * Value: "HTTP" */ FOUNDATION_EXTERN NSString * const kGTLRCloudTasks_UriOverride_Scheme_Http; /** - * Convert the scheme to HTTPS, e.g., http://www.google.ca will change to - * https://www.google.ca. + * Convert the scheme to HTTPS, e.g., "http://www.example.com" will change to + * "https://www.example.com". * * Value: "HTTPS" */ @@ -813,7 +813,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasks_UriOverride_UriOverrideEnforc * Explicitly specifying a task ID enables task de-duplication. If a task's ID * is identical to that of an existing task or a task that was deleted or * executed recently then the call will fail with ALREADY_EXISTS. The IDs of - * deleted tasks are not immediately available for reuse. It can take up to 4 + * deleted tasks are not immediately available for reuse. It can take up to 24 * hours (or 9 days if the task's queue was created using a queue.yaml or * queue.xml) for the task ID to be released and made available again. Because * there is an extra lookup cost to identify duplicate task names, these @@ -2095,9 +2095,10 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasks_UriOverride_UriOverrideEnforc /** * Port override. When specified, replaces the port part of the task URI. For - * instance, for a URI http://www.google.com/foo and port=123, the overridden - * URI becomes http://www.google.com:123/foo. Note that the port value must be - * a positive integer. Setting the port to 0 (Zero) clears the URI port. + * instance, for a URI "https://www.example.com/example" and port=123, the + * overridden URI becomes "https://www.example.com:123/example". Note that the + * port value must be a positive integer. Setting the port to 0 (Zero) clears + * the URI port. * * Uses NSNumber of longLongValue. */ @@ -2115,11 +2116,11 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasks_UriOverride_UriOverrideEnforc * * Likely values: * @arg @c kGTLRCloudTasks_UriOverride_Scheme_Http Convert the scheme to - * HTTP, e.g., https://www.google.ca will change to http://www.google.ca. - * (Value: "HTTP") + * HTTP, e.g., "https://www.example.com" will change to + * "http://www.example.com". (Value: "HTTP") * @arg @c kGTLRCloudTasks_UriOverride_Scheme_Https Convert the scheme to - * HTTPS, e.g., http://www.google.ca will change to - * https://www.google.ca. (Value: "HTTPS") + * HTTPS, e.g., "http://www.example.com" will change to + * "https://www.example.com". (Value: "HTTPS") * @arg @c kGTLRCloudTasks_UriOverride_Scheme_SchemeUnspecified Scheme * unspecified. Defaults to HTTPS. (Value: "SCHEME_UNSPECIFIED") */ diff --git a/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksQuery.h b/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksQuery.h index b4b118480..80e599ea5 100644 --- a/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksQuery.h +++ b/Sources/GeneratedServices/CloudTasks/Public/GoogleAPIClientForREST/GTLRCloudTasksQuery.h @@ -136,8 +136,8 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasksResponseViewViewUnspecified; @interface GTLRCloudTasksQuery_ProjectsLocationsList : GTLRCloudTasksQuery /** - * Optional. A list of extra location types that should be used as conditions - * for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -787,7 +787,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasksResponseViewViewUnspecified; @end /** - * Gets a task. + * Gets a task. After a task is successfully executed or has exhausted its + * retry attempts, the task is deleted. A `GetTask` request for a deleted task + * returns a `NOT_FOUND` error. * * Method: cloudtasks.projects.locations.queues.tasks.get * @@ -828,7 +830,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCloudTasksResponseViewViewUnspecified; /** * Fetches a @c GTLRCloudTasks_Task. * - * Gets a task. + * Gets a task. After a task is successfully executed or has exhausted its + * retry attempts, the task is deleted. A `GetTask` request for a deleted task + * returns a `NOT_FOUND` error. * * @param name Required. The task name. For example: * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` diff --git a/Sources/GeneratedServices/CloudWorkstations/Public/GoogleAPIClientForREST/GTLRCloudWorkstationsQuery.h b/Sources/GeneratedServices/CloudWorkstations/Public/GoogleAPIClientForREST/GTLRCloudWorkstationsQuery.h index 1ee08f247..76b10a2e2 100644 --- a/Sources/GeneratedServices/CloudWorkstations/Public/GoogleAPIClientForREST/GTLRCloudWorkstationsQuery.h +++ b/Sources/GeneratedServices/CloudWorkstations/Public/GoogleAPIClientForREST/GTLRCloudWorkstationsQuery.h @@ -71,8 +71,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRCloudWorkstationsQuery_ProjectsLocationsList : GTLRCloudWorkstationsQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelObjects.m b/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelObjects.m index 6fcb2523a..4b3ff9390 100644 --- a/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelObjects.m +++ b/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelObjects.m @@ -2142,11 +2142,12 @@ @implementation GTLRCloudchannel_GoogleLongrunningCancelOperationRequest // @implementation GTLRCloudchannel_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRCloudchannel_GoogleLongrunningOperation class] + @"operations" : [GTLRCloudchannel_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelQuery.m b/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelQuery.m index de73c3531..a7c8019e0 100644 --- a/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelQuery.m +++ b/Sources/GeneratedServices/Cloudchannel/GTLRCloudchannelQuery.m @@ -1514,7 +1514,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRCloudchannelQuery_OperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelObjects.h b/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelObjects.h index 8752858d0..ddad977ab 100644 --- a/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelObjects.h +++ b/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelObjects.h @@ -5995,6 +5995,13 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelQuery.h b/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelQuery.h index ef4367cd6..d78c34620 100644 --- a/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelQuery.h +++ b/Sources/GeneratedServices/Cloudchannel/Public/GoogleAPIClientForREST/GTLRCloudchannelQuery.h @@ -3728,6 +3728,17 @@ GTLR_DEPRECATED /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRCloudchannel_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/Compute/GTLRComputeObjects.m b/Sources/GeneratedServices/Compute/GTLRComputeObjects.m index d5bc385d5..536fc0663 100644 --- a/Sources/GeneratedServices/Compute/GTLRComputeObjects.m +++ b/Sources/GeneratedServices/Compute/GTLRComputeObjects.m @@ -2600,6 +2600,10 @@ NSString * const kGTLRCompute_Interconnect_State_Active = @"ACTIVE"; NSString * const kGTLRCompute_Interconnect_State_Unprovisioned = @"UNPROVISIONED"; +// GTLRCompute_Interconnect.subzone +NSString * const kGTLRCompute_Interconnect_Subzone_SubzoneA = @"SUBZONE_A"; +NSString * const kGTLRCompute_Interconnect_Subzone_SubzoneB = @"SUBZONE_B"; + // GTLRCompute_InterconnectApplicationAwareInterconnectBandwidthPercentage.trafficClass NSString * const kGTLRCompute_InterconnectApplicationAwareInterconnectBandwidthPercentage_TrafficClass_Tc1 = @"TC1"; NSString * const kGTLRCompute_InterconnectApplicationAwareInterconnectBandwidthPercentage_TrafficClass_Tc2 = @"TC2"; @@ -4617,6 +4621,53 @@ NSString * const kGTLRCompute_PreservedStatePreservedNetworkIp_AutoDelete_Never = @"NEVER"; NSString * const kGTLRCompute_PreservedStatePreservedNetworkIp_AutoDelete_OnPermanentInstanceDeletion = @"ON_PERMANENT_INSTANCE_DELETION"; +// GTLRCompute_PreviewFeature.activationStatus +NSString * const kGTLRCompute_PreviewFeature_ActivationStatus_ActivationStateUnspecified = @"ACTIVATION_STATE_UNSPECIFIED"; +NSString * const kGTLRCompute_PreviewFeature_ActivationStatus_Disabled = @"DISABLED"; +NSString * const kGTLRCompute_PreviewFeature_ActivationStatus_Enabled = @"ENABLED"; + +// GTLRCompute_PreviewFeatureList_Warning.code +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_CleanupFailed = @"CLEANUP_FAILED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_DeprecatedResourceUsed = @"DEPRECATED_RESOURCE_USED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_DeprecatedTypeUsed = @"DEPRECATED_TYPE_USED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_DiskSizeLargerThanImageSize = @"DISK_SIZE_LARGER_THAN_IMAGE_SIZE"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ExperimentalTypeUsed = @"EXPERIMENTAL_TYPE_USED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ExternalApiWarning = @"EXTERNAL_API_WARNING"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_FieldValueOverriden = @"FIELD_VALUE_OVERRIDEN"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_InjectedKernelsDeprecated = @"INJECTED_KERNELS_DEPRECATED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_InvalidHealthCheckForDynamicWieghtedLb = @"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_LargeDeploymentWarning = @"LARGE_DEPLOYMENT_WARNING"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ListOverheadQuotaExceed = @"LIST_OVERHEAD_QUOTA_EXCEED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_MissingTypeDependency = @"MISSING_TYPE_DEPENDENCY"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopAddressNotAssigned = @"NEXT_HOP_ADDRESS_NOT_ASSIGNED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopCannotIpForward = @"NEXT_HOP_CANNOT_IP_FORWARD"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceHasNoIpv6Interface = @"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceNotFound = @"NEXT_HOP_INSTANCE_NOT_FOUND"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceNotOnNetwork = @"NEXT_HOP_INSTANCE_NOT_ON_NETWORK"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopNotRunning = @"NEXT_HOP_NOT_RUNNING"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NoResultsOnPage = @"NO_RESULTS_ON_PAGE"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NotCriticalError = @"NOT_CRITICAL_ERROR"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_PartialSuccess = @"PARTIAL_SUCCESS"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_QuotaInfoUnavailable = @"QUOTA_INFO_UNAVAILABLE"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_RequiredTosAgreement = @"REQUIRED_TOS_AGREEMENT"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ResourceInUseByOtherResourceWarning = @"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ResourceNotDeleted = @"RESOURCE_NOT_DELETED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_SchemaValidationIgnored = @"SCHEMA_VALIDATION_IGNORED"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_SingleInstancePropertyTemplate = @"SINGLE_INSTANCE_PROPERTY_TEMPLATE"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_UndeclaredProperties = @"UNDECLARED_PROPERTIES"; +NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_Unreachable = @"UNREACHABLE"; + +// GTLRCompute_PreviewFeatureRolloutOperationRolloutInput.predefinedRolloutPlan +NSString * const kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanFastRollout = @"ROLLOUT_PLAN_FAST_ROLLOUT"; +NSString * const kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanTwoDayRollout = @"ROLLOUT_PLAN_TWO_DAY_ROLLOUT"; +NSString * const kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanUnspecified = @"ROLLOUT_PLAN_UNSPECIFIED"; + +// GTLRCompute_PreviewFeatureStatusReleaseStatus.stage +NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Deprecated = @"DEPRECATED"; +NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Ga = @"GA"; +NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Preview = @"PREVIEW"; +NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_StageUnspecified = @"STAGE_UNSPECIFIED"; + // GTLRCompute_Project.cloudArmorTier NSString * const kGTLRCompute_Project_CloudArmorTier_CaEnterpriseAnnual = @"CA_ENTERPRISE_ANNUAL"; NSString * const kGTLRCompute_Project_CloudArmorTier_CaEnterprisePaygo = @"CA_ENTERPRISE_PAYGO"; @@ -5481,6 +5532,21 @@ NSString * const kGTLRCompute_ReservationSubBlocksListResponse_Warning_Code_UndeclaredProperties = @"UNDECLARED_PROPERTIES"; NSString * const kGTLRCompute_ReservationSubBlocksListResponse_Warning_Code_Unreachable = @"UNREACHABLE"; +// GTLRCompute_ReservationSubBlocksReportFaultyRequest.disruptionSchedule +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_DisruptionSchedule_DisruptionScheduleUnspecified = @"DISRUPTION_SCHEDULE_UNSPECIFIED"; +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_DisruptionSchedule_Immediate = @"IMMEDIATE"; + +// GTLRCompute_ReservationSubBlocksReportFaultyRequest.failureComponent +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_FailureComponentUnspecified = @"FAILURE_COMPONENT_UNSPECIFIED"; +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_MultipleFaultyHosts = @"MULTIPLE_FAULTY_HOSTS"; +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_NvlinkSwitch = @"NVLINK_SWITCH"; + +// GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason.behavior +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_FaultBehaviorUnspecified = @"FAULT_BEHAVIOR_UNSPECIFIED"; +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_GpuError = @"GPU_ERROR"; +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_Performance = @"PERFORMANCE"; +NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_SwitchFailure = @"SWITCH_FAILURE"; + // GTLRCompute_ResourceCommitment.type NSString * const kGTLRCompute_ResourceCommitment_Type_Accelerator = @"ACCELERATOR"; NSString * const kGTLRCompute_ResourceCommitment_Type_LocalSsd = @"LOCAL_SSD"; @@ -10515,6 +10581,16 @@ @implementation GTLRCompute_CustomErrorResponsePolicyCustomErrorResponseRule @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_Date +// + +@implementation GTLRCompute_Date +@dynamic day, month, year; +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_DeprecationStatus @@ -12969,12 +13045,12 @@ @implementation GTLRCompute_Image @dynamic architecture, archiveSizeBytes, creationTimestamp, deprecated, descriptionProperty, diskSizeGb, enableConfidentialCompute, family, guestOsFeatures, identifier, imageEncryptionKey, kind, - labelFingerprint, labels, licenseCodes, licenses, name, rawDisk, - satisfiesPzi, satisfiesPzs, selfLink, shieldedInstanceInitialState, - sourceDisk, sourceDiskEncryptionKey, sourceDiskId, sourceImage, - sourceImageEncryptionKey, sourceImageId, sourceSnapshot, - sourceSnapshotEncryptionKey, sourceSnapshotId, sourceType, status, - storageLocations; + labelFingerprint, labels, licenseCodes, licenses, name, params, + rawDisk, satisfiesPzi, satisfiesPzs, selfLink, + shieldedInstanceInitialState, sourceDisk, sourceDiskEncryptionKey, + sourceDiskId, sourceImage, sourceImageEncryptionKey, sourceImageId, + sourceSnapshot, sourceSnapshotEncryptionKey, sourceSnapshotId, + sourceType, status, storageLocations; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -13081,6 +13157,30 @@ @implementation GTLRCompute_ImageList_Warning_Data_Item @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_ImageParams +// + +@implementation GTLRCompute_ImageParams +@dynamic resourceManagerTags; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_ImageParams_ResourceManagerTags +// + +@implementation GTLRCompute_ImageParams_ResourceManagerTags + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_InitialStateConfig @@ -15470,7 +15570,8 @@ @implementation GTLRCompute_Interconnect interconnectGroups, interconnectType, kind, labelFingerprint, labels, linkType, location, macsec, macsecEnabled, name, nocContactEmail, operationalStatus, peerIpAddress, provisionedLinkCount, remoteLocation, - requestedFeatures, requestedLinkCount, satisfiesPzs, selfLink, state; + requestedFeatures, requestedLinkCount, satisfiesPzs, selfLink, state, + subzone; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -16604,7 +16705,8 @@ @implementation GTLRCompute_InterconnectLocation @dynamic address, availabilityZone, availableFeatures, availableLinkTypes, city, continent, creationTimestamp, descriptionProperty, facilityProvider, facilityProviderFacilityId, identifier, kind, name, - peeringdbFacilityId, regionInfos, selfLink, status, supportsPzs; + peeringdbFacilityId, regionInfos, selfLink, + singleRegionProductionCriticalPeerLocations, status, supportsPzs; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -16618,7 +16720,8 @@ @implementation GTLRCompute_InterconnectLocation NSDictionary *map = @{ @"availableFeatures" : [NSString class], @"availableLinkTypes" : [NSString class], - @"regionInfos" : [GTLRCompute_InterconnectLocationRegionInfo class] + @"regionInfos" : [GTLRCompute_InterconnectLocationRegionInfo class], + @"singleRegionProductionCriticalPeerLocations" : [NSString class] }; return map; } @@ -16774,8 +16877,8 @@ @implementation GTLRCompute_InterconnectRemoteLocation @dynamic address, attachmentConfigurationConstraints, city, constraints, continent, creationTimestamp, descriptionProperty, facilityProvider, facilityProviderFacilityId, identifier, kind, lacp, maxLagSize100Gbps, - maxLagSize10Gbps, name, peeringdbFacilityId, permittedConnections, - remoteService, selfLink, status; + maxLagSize10Gbps, maxLagSize400Gbps, name, peeringdbFacilityId, + permittedConnections, remoteService, selfLink, status; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -19905,6 +20008,24 @@ @implementation GTLRCompute_OperationsScopedList_Warning_Data_Item @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse +// + +@implementation GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse +@dynamic associations, kind; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"associations" : [GTLRCompute_SecurityPolicyAssociation class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_OutlierDetection @@ -20380,6 +20501,127 @@ @implementation GTLRCompute_PreservedStatePreservedNetworkIpIpAddress @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeature +// + +@implementation GTLRCompute_PreviewFeature +@dynamic activationStatus, creationTimestamp, descriptionProperty, identifier, + kind, name, rolloutOperation, selfLink, status; + ++ (NSDictionary *)propertyToJSONKeyMap { + NSDictionary *map = @{ + @"descriptionProperty" : @"description", + @"identifier" : @"id" + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureList +// + +@implementation GTLRCompute_PreviewFeatureList +@dynamic ETag, identifier, items, nextPageToken, selfLink, unreachables, + warning; + ++ (NSDictionary *)propertyToJSONKeyMap { + NSDictionary *map = @{ + @"ETag" : @"etag", + @"identifier" : @"id" + }; + return map; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"items" : [GTLRCompute_PreviewFeature class], + @"unreachables" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureList_Warning +// + +@implementation GTLRCompute_PreviewFeatureList_Warning +@dynamic code, data, message; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"data" : [GTLRCompute_PreviewFeatureList_Warning_Data_Item class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureList_Warning_Data_Item +// + +@implementation GTLRCompute_PreviewFeatureList_Warning_Data_Item +@dynamic key, value; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureRolloutOperation +// + +@implementation GTLRCompute_PreviewFeatureRolloutOperation +@dynamic rolloutInput; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureRolloutOperationRolloutInput +// + +@implementation GTLRCompute_PreviewFeatureRolloutOperationRolloutInput +@dynamic name, predefinedRolloutPlan; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureStatus +// + +@implementation GTLRCompute_PreviewFeatureStatus +@dynamic descriptionProperty, helpLink, releaseStatus; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_PreviewFeatureStatusReleaseStatus +// + +@implementation GTLRCompute_PreviewFeatureStatusReleaseStatus +@dynamic stage, updateDate; +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_Project @@ -21759,7 +22001,7 @@ @implementation GTLRCompute_RegionUrlMapsValidateRequest // @implementation GTLRCompute_RequestMirrorPolicy -@dynamic backendService; +@dynamic backendService, mirrorPercent; @end @@ -22260,6 +22502,39 @@ @implementation GTLRCompute_ReservationSubBlocksListResponse_Warning_Data_Item @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_ReservationSubBlocksReportFaultyRequest +// + +@implementation GTLRCompute_ReservationSubBlocksReportFaultyRequest +@dynamic disruptionSchedule, failureComponent, faultReasons; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"faultReasons" : [GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason +// + +@implementation GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason +@dynamic behavior, descriptionProperty; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_ResourceCommitment @@ -23798,10 +24073,11 @@ @implementation GTLRCompute_SecurityPoliciesWafConfig // @implementation GTLRCompute_SecurityPolicy -@dynamic adaptiveProtectionConfig, advancedOptionsConfig, creationTimestamp, - ddosProtectionConfig, descriptionProperty, fingerprint, identifier, - kind, labelFingerprint, labels, name, recaptchaOptionsConfig, region, - rules, selfLink, type, userDefinedFields; +@dynamic adaptiveProtectionConfig, advancedOptionsConfig, associations, + creationTimestamp, ddosProtectionConfig, descriptionProperty, + fingerprint, identifier, kind, labelFingerprint, labels, name, + recaptchaOptionsConfig, region, rules, selfLink, shortName, type, + userDefinedFields; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -23813,6 +24089,7 @@ @implementation GTLRCompute_SecurityPolicy + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"associations" : [GTLRCompute_SecurityPolicyAssociation class], @"rules" : [GTLRCompute_SecurityPolicyRule class], @"userDefinedFields" : [GTLRCompute_SecurityPolicyUserDefinedField class] }; @@ -23931,6 +24208,26 @@ @implementation GTLRCompute_SecurityPolicyAdvancedOptionsConfigJsonCustomConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_SecurityPolicyAssociation +// + +@implementation GTLRCompute_SecurityPolicyAssociation +@dynamic attachmentId, displayName, excludedFolders, excludedProjects, name, + securityPolicyId, shortName; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"excludedFolders" : [NSString class], + @"excludedProjects" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_SecurityPolicyDdosProtectionConfig @@ -24692,12 +24989,13 @@ @implementation GTLRCompute_Snapshot creationTimestamp, descriptionProperty, diskSizeGb, downloadBytes, enableConfidentialCompute, guestFlush, guestOsFeatures, identifier, kind, labelFingerprint, labels, licenseCodes, licenses, locationHint, - name, satisfiesPzi, satisfiesPzs, selfLink, snapshotEncryptionKey, - snapshotType, sourceDisk, sourceDiskEncryptionKey, - sourceDiskForRecoveryCheckpoint, sourceDiskId, sourceInstantSnapshot, - sourceInstantSnapshotEncryptionKey, sourceInstantSnapshotId, - sourceSnapshotSchedulePolicy, sourceSnapshotSchedulePolicyId, status, - storageBytes, storageBytesStatus, storageLocations; + name, params, satisfiesPzi, satisfiesPzs, selfLink, + snapshotEncryptionKey, snapshotType, sourceDisk, + sourceDiskEncryptionKey, sourceDiskForRecoveryCheckpoint, sourceDiskId, + sourceInstantSnapshot, sourceInstantSnapshotEncryptionKey, + sourceInstantSnapshotId, sourceSnapshotSchedulePolicy, + sourceSnapshotSchedulePolicyId, status, storageBytes, + storageBytesStatus, storageLocations; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -24784,6 +25082,30 @@ @implementation GTLRCompute_SnapshotList_Warning_Data_Item @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_SnapshotParams +// + +@implementation GTLRCompute_SnapshotParams +@dynamic resourceManagerTags; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_SnapshotParams_ResourceManagerTags +// + +@implementation GTLRCompute_SnapshotParams_ResourceManagerTags + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_SnapshotSettings @@ -26000,7 +26322,7 @@ @implementation GTLRCompute_Subnetwork privateIpGoogleAccess, privateIpv6GoogleAccess, purpose, region, reservedInternalRange, role, secondaryIpRanges, selfLink, stackType, state, systemReservedExternalIpv6Ranges, - systemReservedInternalIpv6Ranges; + systemReservedInternalIpv6Ranges, utilizationDetails; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ @@ -26294,6 +26616,45 @@ @implementation GTLRCompute_SubnetworksSetPrivateIpGoogleAccessRequest @end +// ---------------------------------------------------------------------------- +// +// GTLRCompute_SubnetworkUtilizationDetails +// + +@implementation GTLRCompute_SubnetworkUtilizationDetails +@dynamic externalIpv6InstanceUtilization, externalIpv6LbUtilization, + internalIpv6Utilization, ipv4Utilizations; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"ipv4Utilizations" : [GTLRCompute_SubnetworkUtilizationDetailsIPV4Utilization class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_SubnetworkUtilizationDetailsIPV4Utilization +// + +@implementation GTLRCompute_SubnetworkUtilizationDetailsIPV4Utilization +@dynamic rangeName, totalAllocatedIp, totalFreeIp; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization +// + +@implementation GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization +@dynamic totalAllocatedIp, totalFreeIp; +@end + + // ---------------------------------------------------------------------------- // // GTLRCompute_Subsetting diff --git a/Sources/GeneratedServices/Compute/GTLRComputeQuery.m b/Sources/GeneratedServices/Compute/GTLRComputeQuery.m index 0c7499fdb..2336b0dc8 100644 --- a/Sources/GeneratedServices/Compute/GTLRComputeQuery.m +++ b/Sources/GeneratedServices/Compute/GTLRComputeQuery.m @@ -44,6 +44,10 @@ NSString * const kGTLRComputeViewBlockViewUnspecified = @"BLOCK_VIEW_UNSPECIFIED"; NSString * const kGTLRComputeViewFull = @"FULL"; +// views +NSString * const kGTLRComputeViewsDefault = @"DEFAULT"; +NSString * const kGTLRComputeViewsWithUtilization = @"WITH_UTILIZATION"; + // ---------------------------------------------------------------------------- // Query Classes // @@ -1017,6 +1021,28 @@ + (instancetype)queryWithProject:(NSString *)project @end +@implementation GTLRComputeQuery_BackendServicesGetEffectiveSecurityPolicies + +@dynamic backendService, project; + ++ (instancetype)queryWithProject:(NSString *)project + backendService:(NSString *)backendService { + NSArray *pathParams = @[ + @"backendService", @"project" + ]; + NSString *pathURITemplate = @"projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies"; + GTLRComputeQuery_BackendServicesGetEffectiveSecurityPolicies *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.project = project; + query.backendService = backendService; + query.loggingName = @"compute.backendServices.getEffectiveSecurityPolicies"; + return query; +} + +@end + @implementation GTLRComputeQuery_BackendServicesGetHealth @dynamic backendService, project; @@ -12040,6 +12066,341 @@ + (instancetype)queryWithProject:(NSString *)project @end +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesAddAssociation + +@dynamic replaceExistingAssociation, requestId, securityPolicy; + ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicyAssociation *)object + securityPolicy:(NSString *)securityPolicy { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/addAssociation"; + GTLRComputeQuery_OrganizationSecurityPoliciesAddAssociation *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.addAssociation"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesAddRule + +@dynamic requestId, securityPolicy; + ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicyRule *)object + securityPolicy:(NSString *)securityPolicy { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/addRule"; + GTLRComputeQuery_OrganizationSecurityPoliciesAddRule *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.addRule"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesCopyRules + +@dynamic requestId, securityPolicy, sourceSecurityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/copyRules"; + GTLRComputeQuery_OrganizationSecurityPoliciesCopyRules *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.copyRules"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesDelete + +@dynamic requestId, securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}"; + GTLRComputeQuery_OrganizationSecurityPoliciesDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.delete"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesGet + +@dynamic securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}"; + GTLRComputeQuery_OrganizationSecurityPoliciesGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_SecurityPolicy class]; + query.loggingName = @"compute.organizationSecurityPolicies.get"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesGetAssociation + +@dynamic name, securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/getAssociation"; + GTLRComputeQuery_OrganizationSecurityPoliciesGetAssociation *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_SecurityPolicyAssociation class]; + query.loggingName = @"compute.organizationSecurityPolicies.getAssociation"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesGetRule + +@dynamic priority, securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/getRule"; + GTLRComputeQuery_OrganizationSecurityPoliciesGetRule *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_SecurityPolicyRule class]; + query.loggingName = @"compute.organizationSecurityPolicies.getRule"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesInsert + +@dynamic parentId, requestId; + ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicy *)object { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSString *pathURITemplate = @"locations/global/securityPolicies"; + GTLRComputeQuery_OrganizationSecurityPoliciesInsert *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:nil]; + query.bodyObject = object; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.insert"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesList + +@dynamic filter, maxResults, orderBy, pageToken, parentId, returnPartialSuccess; + ++ (instancetype)query { + NSString *pathURITemplate = @"locations/global/securityPolicies"; + GTLRComputeQuery_OrganizationSecurityPoliciesList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:nil]; + query.expectedObjectClass = [GTLRCompute_SecurityPolicyList class]; + query.loggingName = @"compute.organizationSecurityPolicies.list"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesListAssociations + +@dynamic targetResource; + ++ (instancetype)query { + NSString *pathURITemplate = @"locations/global/securityPolicies/listAssociations"; + GTLRComputeQuery_OrganizationSecurityPoliciesListAssociations *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:nil]; + query.expectedObjectClass = [GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse class]; + query.loggingName = @"compute.organizationSecurityPolicies.listAssociations"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesListPreconfiguredExpressionSets + +@dynamic filter, maxResults, orderBy, pageToken, parentId, returnPartialSuccess; + ++ (instancetype)query { + NSString *pathURITemplate = @"locations/global/securityPolicies/listPreconfiguredExpressionSets"; + GTLRComputeQuery_OrganizationSecurityPoliciesListPreconfiguredExpressionSets *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:nil]; + query.expectedObjectClass = [GTLRCompute_SecurityPoliciesListPreconfiguredExpressionSetsResponse class]; + query.loggingName = @"compute.organizationSecurityPolicies.listPreconfiguredExpressionSets"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesMove + +@dynamic parentId, requestId, securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/move"; + GTLRComputeQuery_OrganizationSecurityPoliciesMove *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.move"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesPatch + +@dynamic requestId, securityPolicy; + ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicy *)object + securityPolicy:(NSString *)securityPolicy { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}"; + GTLRComputeQuery_OrganizationSecurityPoliciesPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.patch"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesPatchRule + +@dynamic priority, requestId, securityPolicy; + ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicyRule *)object + securityPolicy:(NSString *)securityPolicy { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/patchRule"; + GTLRComputeQuery_OrganizationSecurityPoliciesPatchRule *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.patchRule"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesRemoveAssociation + +@dynamic name, requestId, securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/removeAssociation"; + GTLRComputeQuery_OrganizationSecurityPoliciesRemoveAssociation *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.removeAssociation"; + return query; +} + +@end + +@implementation GTLRComputeQuery_OrganizationSecurityPoliciesRemoveRule + +@dynamic priority, requestId, securityPolicy; + ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy { + NSArray *pathParams = @[ @"securityPolicy" ]; + NSString *pathURITemplate = @"locations/global/securityPolicies/{securityPolicy}/removeRule"; + GTLRComputeQuery_OrganizationSecurityPoliciesRemoveRule *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.securityPolicy = securityPolicy; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.organizationSecurityPolicies.removeRule"; + return query; +} + +@end + @implementation GTLRComputeQuery_PacketMirroringsAggregatedList @dynamic filter, includeAllScopes, maxResults, orderBy, pageToken, project, @@ -12231,6 +12592,79 @@ + (instancetype)queryWithObject:(GTLRCompute_TestPermissionsRequest *)object @end +@implementation GTLRComputeQuery_PreviewFeaturesGet + +@dynamic previewFeature, project; + ++ (instancetype)queryWithProject:(NSString *)project + previewFeature:(NSString *)previewFeature { + NSArray *pathParams = @[ + @"previewFeature", @"project" + ]; + NSString *pathURITemplate = @"projects/{project}/global/previewFeatures/{previewFeature}"; + GTLRComputeQuery_PreviewFeaturesGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.project = project; + query.previewFeature = previewFeature; + query.expectedObjectClass = [GTLRCompute_PreviewFeature class]; + query.loggingName = @"compute.previewFeatures.get"; + return query; +} + +@end + +@implementation GTLRComputeQuery_PreviewFeaturesList + +@dynamic filter, maxResults, orderBy, pageToken, project, returnPartialSuccess; + ++ (instancetype)queryWithProject:(NSString *)project { + NSArray *pathParams = @[ @"project" ]; + NSString *pathURITemplate = @"projects/{project}/global/previewFeatures"; + GTLRComputeQuery_PreviewFeaturesList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.project = project; + query.expectedObjectClass = [GTLRCompute_PreviewFeatureList class]; + query.loggingName = @"compute.previewFeatures.list"; + return query; +} + +@end + +@implementation GTLRComputeQuery_PreviewFeaturesUpdate + +@dynamic previewFeature, project, requestId; + ++ (instancetype)queryWithObject:(GTLRCompute_PreviewFeature *)object + project:(NSString *)project + previewFeature:(NSString *)previewFeature { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ + @"previewFeature", @"project" + ]; + NSString *pathURITemplate = @"projects/{project}/global/previewFeatures/{previewFeature}"; + GTLRComputeQuery_PreviewFeaturesUpdate *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.project = project; + query.previewFeature = previewFeature; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.previewFeatures.update"; + return query; +} + +@end + @implementation GTLRComputeQuery_ProjectsDisableXpnHost @dynamic project, requestId; @@ -18362,6 +18796,45 @@ + (instancetype)queryWithProject:(NSString *)project @end +@implementation GTLRComputeQuery_ReservationSubBlocksReportFaulty + +@dynamic parentName, project, requestId, reservationSubBlock, zoneProperty; + ++ (NSDictionary *)parameterNameMap { + return @{ @"zoneProperty" : @"zone" }; +} + ++ (instancetype)queryWithObject:(GTLRCompute_ReservationSubBlocksReportFaultyRequest *)object + project:(NSString *)project + zoneProperty:(NSString *)zoneProperty + parentName:(NSString *)parentName + reservationSubBlock:(NSString *)reservationSubBlock { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ + @"parentName", @"project", @"reservationSubBlock", @"zone" + ]; + NSString *pathURITemplate = @"projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty"; + GTLRComputeQuery_ReservationSubBlocksReportFaulty *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.project = project; + query.zoneProperty = zoneProperty; + query.parentName = parentName; + query.reservationSubBlock = reservationSubBlock; + query.expectedObjectClass = [GTLRCompute_Operation class]; + query.loggingName = @"compute.reservationSubBlocks.reportFaulty"; + return query; +} + +@end + @implementation GTLRComputeQuery_ReservationsUpdate @dynamic paths, project, requestId, reservation, updateMask, zoneProperty; @@ -20762,7 +21235,14 @@ + (instancetype)queryWithObject:(GTLRCompute_SubnetworksExpandIpCidrRangeRequest @implementation GTLRComputeQuery_SubnetworksGet -@dynamic project, region, subnetwork; +@dynamic project, region, subnetwork, views; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"views" : [NSString class] + }; + return map; +} + (instancetype)queryWithProject:(NSString *)project region:(NSString *)region @@ -20844,7 +21324,14 @@ + (instancetype)queryWithObject:(GTLRCompute_Subnetwork *)object @implementation GTLRComputeQuery_SubnetworksList @dynamic filter, maxResults, orderBy, pageToken, project, region, - returnPartialSuccess; + returnPartialSuccess, views; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"views" : [NSString class] + }; + return map; +} + (instancetype)queryWithProject:(NSString *)project region:(NSString *)region { diff --git a/Sources/GeneratedServices/Compute/GTLRComputeService.m b/Sources/GeneratedServices/Compute/GTLRComputeService.m index 003023169..f896eccf6 100644 --- a/Sources/GeneratedServices/Compute/GTLRComputeService.m +++ b/Sources/GeneratedServices/Compute/GTLRComputeService.m @@ -165,9 +165,11 @@ - (instancetype)init { @"compute#operation" : [GTLRCompute_Operation class], @"compute#operationAggregatedList" : [GTLRCompute_OperationAggregatedList class], @"compute#operationList" : [GTLRCompute_OperationList class], + @"compute#organizationSecurityPoliciesListAssociationsResponse" : [GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse class], @"compute#packetMirroring" : [GTLRCompute_PacketMirroring class], @"compute#packetMirroringAggregatedList" : [GTLRCompute_PacketMirroringAggregatedList class], @"compute#packetMirroringList" : [GTLRCompute_PacketMirroringList class], + @"compute#previewFeature" : [GTLRCompute_PreviewFeature class], @"compute#project" : [GTLRCompute_Project class], @"compute#projectsGetXpnResources" : [GTLRCompute_ProjectsGetXpnResources class], @"compute#publicAdvertisedPrefix" : [GTLRCompute_PublicAdvertisedPrefix class], diff --git a/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeObjects.h b/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeObjects.h index 100e4aea5..0bdbbf0c6 100644 --- a/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeObjects.h +++ b/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeObjects.h @@ -152,6 +152,7 @@ @class GTLRCompute_CustomerEncryptionKeyProtectedDisk; @class GTLRCompute_CustomErrorResponsePolicy; @class GTLRCompute_CustomErrorResponsePolicyCustomErrorResponseRule; +@class GTLRCompute_Date; @class GTLRCompute_DeprecationStatus; @class GTLRCompute_Disk; @class GTLRCompute_Disk_AsyncSecondaryDisks; @@ -282,6 +283,8 @@ @class GTLRCompute_Image_RawDisk; @class GTLRCompute_ImageList_Warning; @class GTLRCompute_ImageList_Warning_Data_Item; +@class GTLRCompute_ImageParams; +@class GTLRCompute_ImageParams_ResourceManagerTags; @class GTLRCompute_InitialStateConfig; @class GTLRCompute_Instance; @class GTLRCompute_Instance_Labels; @@ -645,6 +648,13 @@ @class GTLRCompute_PreservedStatePreservedDisk; @class GTLRCompute_PreservedStatePreservedNetworkIp; @class GTLRCompute_PreservedStatePreservedNetworkIpIpAddress; +@class GTLRCompute_PreviewFeature; +@class GTLRCompute_PreviewFeatureList_Warning; +@class GTLRCompute_PreviewFeatureList_Warning_Data_Item; +@class GTLRCompute_PreviewFeatureRolloutOperation; +@class GTLRCompute_PreviewFeatureRolloutOperationRolloutInput; +@class GTLRCompute_PreviewFeatureStatus; +@class GTLRCompute_PreviewFeatureStatusReleaseStatus; @class GTLRCompute_Project; @class GTLRCompute_PublicAdvertisedPrefix; @class GTLRCompute_PublicAdvertisedPrefixList_Warning; @@ -708,6 +718,7 @@ @class GTLRCompute_ReservationSubBlockPhysicalTopology; @class GTLRCompute_ReservationSubBlocksListResponse_Warning; @class GTLRCompute_ReservationSubBlocksListResponse_Warning_Data_Item; +@class GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason; @class GTLRCompute_ResourceCommitment; @class GTLRCompute_ResourcePoliciesScopedList; @class GTLRCompute_ResourcePoliciesScopedList_Warning; @@ -801,6 +812,7 @@ @class GTLRCompute_SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig; @class GTLRCompute_SecurityPolicyAdvancedOptionsConfig; @class GTLRCompute_SecurityPolicyAdvancedOptionsConfigJsonCustomConfig; +@class GTLRCompute_SecurityPolicyAssociation; @class GTLRCompute_SecurityPolicyDdosProtectionConfig; @class GTLRCompute_SecurityPolicyList_Warning; @class GTLRCompute_SecurityPolicyList_Warning_Data_Item; @@ -850,6 +862,8 @@ @class GTLRCompute_Snapshot_Labels; @class GTLRCompute_SnapshotList_Warning; @class GTLRCompute_SnapshotList_Warning_Data_Item; +@class GTLRCompute_SnapshotParams; +@class GTLRCompute_SnapshotParams_ResourceManagerTags; @class GTLRCompute_SnapshotSettingsStorageLocationSettings; @class GTLRCompute_SnapshotSettingsStorageLocationSettings_Locations; @class GTLRCompute_SnapshotSettingsStorageLocationSettingsStorageLocationPreference; @@ -929,6 +943,9 @@ @class GTLRCompute_SubnetworksScopedWarning; @class GTLRCompute_SubnetworksScopedWarning_Warning; @class GTLRCompute_SubnetworksScopedWarning_Warning_Data_Item; +@class GTLRCompute_SubnetworkUtilizationDetails; +@class GTLRCompute_SubnetworkUtilizationDetailsIPV4Utilization; +@class GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization; @class GTLRCompute_Subsetting; @class GTLRCompute_Tags; @class GTLRCompute_TargetGrpcProxy; @@ -15210,6 +15227,22 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_Interconnect_State_Active; */ FOUNDATION_EXTERN NSString * const kGTLRCompute_Interconnect_State_Unprovisioned; +// ---------------------------------------------------------------------------- +// GTLRCompute_Interconnect.subzone + +/** + * Subzone A. + * + * Value: "SUBZONE_A" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_Interconnect_Subzone_SubzoneA; +/** + * Subzone B. + * + * Value: "SUBZONE_B" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_Interconnect_Subzone_SubzoneB; + // ---------------------------------------------------------------------------- // GTLRCompute_InterconnectApplicationAwareInterconnectBandwidthPercentage.trafficClass @@ -25859,6 +25892,228 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_PreservedStatePreservedNetworkIp /** Value: "ON_PERMANENT_INSTANCE_DELETION" */ FOUNDATION_EXTERN NSString * const kGTLRCompute_PreservedStatePreservedNetworkIp_AutoDelete_OnPermanentInstanceDeletion; +// ---------------------------------------------------------------------------- +// GTLRCompute_PreviewFeature.activationStatus + +/** Value: "ACTIVATION_STATE_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeature_ActivationStatus_ActivationStateUnspecified; +/** Value: "DISABLED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeature_ActivationStatus_Disabled; +/** Value: "ENABLED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeature_ActivationStatus_Enabled; + +// ---------------------------------------------------------------------------- +// GTLRCompute_PreviewFeatureList_Warning.code + +/** + * Warning about failed cleanup of transient changes made by a failed + * operation. + * + * Value: "CLEANUP_FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_CleanupFailed; +/** + * A link to a deprecated resource was created. + * + * Value: "DEPRECATED_RESOURCE_USED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_DeprecatedResourceUsed; +/** + * When deploying and at least one of the resources has a type marked as + * deprecated + * + * Value: "DEPRECATED_TYPE_USED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_DeprecatedTypeUsed; +/** + * The user created a boot disk that is larger than image size. + * + * Value: "DISK_SIZE_LARGER_THAN_IMAGE_SIZE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_DiskSizeLargerThanImageSize; +/** + * When deploying and at least one of the resources has a type marked as + * experimental + * + * Value: "EXPERIMENTAL_TYPE_USED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ExperimentalTypeUsed; +/** + * Warning that is present in an external api call + * + * Value: "EXTERNAL_API_WARNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ExternalApiWarning; +/** + * Warning that value of a field has been overridden. Deprecated unused field. + * + * Value: "FIELD_VALUE_OVERRIDEN" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_FieldValueOverriden GTLR_DEPRECATED; +/** + * The operation involved use of an injected kernel, which is deprecated. + * + * Value: "INJECTED_KERNELS_DEPRECATED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_InjectedKernelsDeprecated; +/** + * A WEIGHTED_MAGLEV backend service is associated with a health check that is + * not of type HTTP/HTTPS/HTTP2. + * + * Value: "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_InvalidHealthCheckForDynamicWieghtedLb; +/** + * When deploying a deployment with a exceedingly large number of resources + * + * Value: "LARGE_DEPLOYMENT_WARNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_LargeDeploymentWarning; +/** + * Resource can't be retrieved due to list overhead quota exceed which captures + * the amount of resources filtered out by user-defined list filter. + * + * Value: "LIST_OVERHEAD_QUOTA_EXCEED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ListOverheadQuotaExceed; +/** + * A resource depends on a missing type + * + * Value: "MISSING_TYPE_DEPENDENCY" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_MissingTypeDependency; +/** + * The route's nextHopIp address is not assigned to an instance on the network. + * + * Value: "NEXT_HOP_ADDRESS_NOT_ASSIGNED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopAddressNotAssigned; +/** + * The route's next hop instance cannot ip forward. + * + * Value: "NEXT_HOP_CANNOT_IP_FORWARD" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopCannotIpForward; +/** + * The route's nextHopInstance URL refers to an instance that does not have an + * ipv6 interface on the same network as the route. + * + * Value: "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceHasNoIpv6Interface; +/** + * The route's nextHopInstance URL refers to an instance that does not exist. + * + * Value: "NEXT_HOP_INSTANCE_NOT_FOUND" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceNotFound; +/** + * The route's nextHopInstance URL refers to an instance that is not on the + * same network as the route. + * + * Value: "NEXT_HOP_INSTANCE_NOT_ON_NETWORK" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceNotOnNetwork; +/** + * The route's next hop instance does not have a status of RUNNING. + * + * Value: "NEXT_HOP_NOT_RUNNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopNotRunning; +/** + * No results are present on a particular list page. + * + * Value: "NO_RESULTS_ON_PAGE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NoResultsOnPage; +/** + * Error which is not critical. We decided to continue the process despite the + * mentioned error. + * + * Value: "NOT_CRITICAL_ERROR" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_NotCriticalError; +/** + * Success is reported, but some results may be missing due to errors + * + * Value: "PARTIAL_SUCCESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_PartialSuccess; +/** + * Quota information is not available to client requests (e.g: regions.list). + * + * Value: "QUOTA_INFO_UNAVAILABLE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_QuotaInfoUnavailable; +/** + * The user attempted to use a resource that requires a TOS they have not + * accepted. + * + * Value: "REQUIRED_TOS_AGREEMENT" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_RequiredTosAgreement; +/** + * Warning that a resource is in use. + * + * Value: "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ResourceInUseByOtherResourceWarning; +/** + * One or more of the resources set to auto-delete could not be deleted because + * they were in use. + * + * Value: "RESOURCE_NOT_DELETED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_ResourceNotDeleted; +/** + * When a resource schema validation is ignored. + * + * Value: "SCHEMA_VALIDATION_IGNORED" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_SchemaValidationIgnored; +/** + * Instance template used in instance group manager is valid as such, but its + * application does not make a lot of sense, because it allows only single + * instance in instance group. + * + * Value: "SINGLE_INSTANCE_PROPERTY_TEMPLATE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_SingleInstancePropertyTemplate; +/** + * When undeclared properties in the schema are present + * + * Value: "UNDECLARED_PROPERTIES" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_UndeclaredProperties; +/** + * A given scope cannot be reached. + * + * Value: "UNREACHABLE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureList_Warning_Code_Unreachable; + +// ---------------------------------------------------------------------------- +// GTLRCompute_PreviewFeatureRolloutOperationRolloutInput.predefinedRolloutPlan + +/** Value: "ROLLOUT_PLAN_FAST_ROLLOUT" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanFastRollout; +/** Value: "ROLLOUT_PLAN_TWO_DAY_ROLLOUT" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanTwoDayRollout; +/** Value: "ROLLOUT_PLAN_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRCompute_PreviewFeatureStatusReleaseStatus.stage + +/** Value: "DEPRECATED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Deprecated; +/** Value: "GA" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Ga; +/** Value: "PREVIEW" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Preview; +/** Value: "STAGE_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_StageUnspecified; + // ---------------------------------------------------------------------------- // GTLRCompute_Project.cloudArmorTier @@ -30153,6 +30408,60 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksListResponse */ FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksListResponse_Warning_Code_Unreachable; +// ---------------------------------------------------------------------------- +// GTLRCompute_ReservationSubBlocksReportFaultyRequest.disruptionSchedule + +/** Value: "DISRUPTION_SCHEDULE_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_DisruptionSchedule_DisruptionScheduleUnspecified; +/** + * All VMs will be disrupted immediately. + * + * Value: "IMMEDIATE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_DisruptionSchedule_Immediate; + +// ---------------------------------------------------------------------------- +// GTLRCompute_ReservationSubBlocksReportFaultyRequest.failureComponent + +/** Value: "FAILURE_COMPONENT_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_FailureComponentUnspecified; +/** + * Multiple hosts experienced the fault. + * + * Value: "MULTIPLE_FAULTY_HOSTS" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_MultipleFaultyHosts; +/** + * The NVLink switch experienced the fault. + * + * Value: "NVLINK_SWITCH" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_NvlinkSwitch; + +// ---------------------------------------------------------------------------- +// GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason.behavior + +/** Value: "FAULT_BEHAVIOR_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_FaultBehaviorUnspecified; +/** + * The subBlock experienced a GPU error. + * + * Value: "GPU_ERROR" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_GpuError; +/** + * The subBlock experienced performance issues. + * + * Value: "PERFORMANCE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_Performance; +/** + * The subBlock experienced a switch failure. + * + * Value: "SWITCH_FAILURE" + */ +FOUNDATION_EXTERN NSString * const kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_SwitchFailure; + // ---------------------------------------------------------------------------- // GTLRCompute_ResourceCommitment.type @@ -53786,6 +54095,46 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * Represents a whole or partial calendar date, such as a birthday. The time of + * day and time zone are either specified elsewhere or are insignificant. The + * date is relative to the Gregorian Calendar. This can represent one of the + * following: * A full date, with non-zero year, month, and day values. * A + * month and day, with a zero year (for example, an anniversary). * A year on + * its own, with a zero month and a zero day. * A year and month, with a zero + * day (for example, a credit card expiration date). Related types: * + * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ +@interface GTLRCompute_Date : GTLRObject + +/** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 + * to specify a year by itself or a year and month where the day isn't + * significant. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *day; + +/** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a + * month and day. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *month; + +/** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a + * year. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *year; + +@end + + /** * Deprecation status for a public resource. */ @@ -62328,6 +62677,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl */ @property(nonatomic, copy, nullable) NSString *name; +/** + * Input only. [Input Only] Additional params passed with the request, but not + * persisted as part of resource payload. + */ +@property(nonatomic, strong, nullable) GTLRCompute_ImageParams *params; + /** The parameters of the raw disk image. */ @property(nonatomic, strong, nullable) GTLRCompute_Image_RawDisk *rawDisk; @@ -62705,6 +63060,37 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * Additional image params. + */ +@interface GTLRCompute_ImageParams : GTLRObject + +/** + * Resource manager tags to be bound to the image. Tag keys and values have the + * same definition as resource manager tags. Keys must be in the format + * `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The + * field is ignored (both PUT & PATCH) when empty. + */ +@property(nonatomic, strong, nullable) GTLRCompute_ImageParams_ResourceManagerTags *resourceManagerTags; + +@end + + +/** + * Resource manager tags to be bound to the image. Tag keys and values have the + * same definition as resource manager tags. Keys must be in the format + * `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The + * field is ignored (both PUT & PATCH) when empty. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRCompute_ImageParams_ResourceManagerTags : GTLRObject +@end + + /** * Initial State for shielded instance, these are public keys which are safe to * store in public @@ -69658,6 +70044,18 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl */ @property(nonatomic, copy, nullable) NSString *state; +/** + * Specific subzone in the InterconnectLocation that represents where this + * connection is to be provisioned. + * + * Likely values: + * @arg @c kGTLRCompute_Interconnect_Subzone_SubzoneA Subzone A. (Value: + * "SUBZONE_A") + * @arg @c kGTLRCompute_Interconnect_Subzone_SubzoneB Subzone B. (Value: + * "SUBZONE_B") + */ +@property(nonatomic, copy, nullable) NSString *subzone; + @end @@ -72777,6 +73175,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl /** [Output Only] Server-defined URL for the resource. */ @property(nonatomic, copy, nullable) NSString *selfLink; +/** + * [Output Only] URLs of the other locations that can pair up with this + * location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and + * iad-zone2-5467 are Single-Region 99.99% peer locations of each other. + */ +@property(nonatomic, strong, nullable) NSArray *singleRegionProductionCriticalPeerLocations; + /** * [Output Only] The status of this InterconnectLocation, which can take one of * the following values: - CLOSED: The InterconnectLocation is closed and is @@ -73359,6 +73764,15 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl */ @property(nonatomic, strong, nullable) NSNumber *maxLagSize10Gbps; +/** + * [Output Only] The maximum number of 400 Gbps ports supported in a link + * aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount + * cannot exceed max_lag_size_400_gbps. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxLagSize400Gbps; + /** [Output Only] Name of the resource. */ @property(nonatomic, copy, nullable) NSString *name; @@ -83678,6 +84092,24 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse + */ +@interface GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse : GTLRObject + +/** A list of associations. */ +@property(nonatomic, strong, nullable) NSArray *associations; + +/** + * [Output Only] Type of securityPolicy associations. Always + * compute#organizationSecurityPoliciesListAssociations for lists of + * securityPolicy associations. + */ +@property(nonatomic, copy, nullable) NSString *kind; + +@end + + /** * Settings controlling the eviction of unhealthy hosts from the load balancing * pool for the backend service. @@ -85158,6 +85590,343 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * Represents a single Google Compute Engine preview feature. + */ +@interface GTLRCompute_PreviewFeature : GTLRObject + +/** + * Specifies whether the feature is enabled or disabled. + * + * Likely values: + * @arg @c kGTLRCompute_PreviewFeature_ActivationStatus_ActivationStateUnspecified + * Value "ACTIVATION_STATE_UNSPECIFIED" + * @arg @c kGTLRCompute_PreviewFeature_ActivationStatus_Disabled Value + * "DISABLED" + * @arg @c kGTLRCompute_PreviewFeature_ActivationStatus_Enabled Value + * "ENABLED" + */ +@property(nonatomic, copy, nullable) NSString *activationStatus; + +/** [Output Only] Creation timestamp in RFC3339 text format. */ +@property(nonatomic, copy, nullable) NSString *creationTimestamp; + +/** + * [Output Only] Description of the feature. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + * + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + * + * Uses NSNumber of unsignedLongLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *identifier; + +/** + * [Output only] The type of the feature. Always "compute#previewFeature" for + * preview features. + */ +@property(nonatomic, copy, nullable) NSString *kind; + +/** Name of the feature. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Rollout operation of the feature. */ +@property(nonatomic, strong, nullable) GTLRCompute_PreviewFeatureRolloutOperation *rolloutOperation; + +/** [Output Only] Server-defined URL for the resource. */ +@property(nonatomic, copy, nullable) NSString *selfLink; + +/** [Output only] Status of the feature. */ +@property(nonatomic, strong, nullable) GTLRCompute_PreviewFeatureStatus *status; + +@end + + +/** + * GTLRCompute_PreviewFeatureList + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "items" property. If returned as the result of a query, it should + * support automatic pagination (when @c shouldFetchNextPages is + * enabled). + */ +@interface GTLRCompute_PreviewFeatureList : GTLRCollectionObject + +@property(nonatomic, copy, nullable) NSString *ETag; + +/** + * [Output Only] Unique identifier for the resource; defined by the server. + * + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + */ +@property(nonatomic, copy, nullable) NSString *identifier; + +/** + * A list of PreviewFeature resources. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *items; + +/** + * [Output Only] This token allows you to get the next page of results for list + * requests. If the number of results is larger than maxResults, use the + * nextPageToken as a value for the query parameter pageToken in the next list + * request. Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +/** [Output Only] Server-defined URL for this resource. */ +@property(nonatomic, copy, nullable) NSString *selfLink; + +/** + * [Output Only] Unreachable resources. end_interface: + * MixerListResponseWithEtagBuilder + */ +@property(nonatomic, strong, nullable) NSArray *unreachables; + +/** [Output Only] Informational warning message. */ +@property(nonatomic, strong, nullable) GTLRCompute_PreviewFeatureList_Warning *warning; + +@end + + +/** + * [Output Only] Informational warning message. + */ +@interface GTLRCompute_PreviewFeatureList_Warning : GTLRObject + +/** + * [Output Only] A warning code, if applicable. For example, Compute Engine + * returns NO_RESULTS_ON_PAGE if there are no results in the response. + * + * Likely values: + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_CleanupFailed Warning + * about failed cleanup of transient changes made by a failed operation. + * (Value: "CLEANUP_FAILED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_DeprecatedResourceUsed + * A link to a deprecated resource was created. (Value: + * "DEPRECATED_RESOURCE_USED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_DeprecatedTypeUsed + * When deploying and at least one of the resources has a type marked as + * deprecated (Value: "DEPRECATED_TYPE_USED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_DiskSizeLargerThanImageSize + * The user created a boot disk that is larger than image size. (Value: + * "DISK_SIZE_LARGER_THAN_IMAGE_SIZE") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_ExperimentalTypeUsed + * When deploying and at least one of the resources has a type marked as + * experimental (Value: "EXPERIMENTAL_TYPE_USED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_ExternalApiWarning + * Warning that is present in an external api call (Value: + * "EXTERNAL_API_WARNING") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_FieldValueOverriden + * Warning that value of a field has been overridden. Deprecated unused + * field. (Value: "FIELD_VALUE_OVERRIDEN") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_InjectedKernelsDeprecated + * The operation involved use of an injected kernel, which is deprecated. + * (Value: "INJECTED_KERNELS_DEPRECATED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_InvalidHealthCheckForDynamicWieghtedLb + * A WEIGHTED_MAGLEV backend service is associated with a health check + * that is not of type HTTP/HTTPS/HTTP2. (Value: + * "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_LargeDeploymentWarning + * When deploying a deployment with a exceedingly large number of + * resources (Value: "LARGE_DEPLOYMENT_WARNING") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_ListOverheadQuotaExceed + * Resource can't be retrieved due to list overhead quota exceed which + * captures the amount of resources filtered out by user-defined list + * filter. (Value: "LIST_OVERHEAD_QUOTA_EXCEED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_MissingTypeDependency + * A resource depends on a missing type (Value: + * "MISSING_TYPE_DEPENDENCY") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopAddressNotAssigned + * The route's nextHopIp address is not assigned to an instance on the + * network. (Value: "NEXT_HOP_ADDRESS_NOT_ASSIGNED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopCannotIpForward + * The route's next hop instance cannot ip forward. (Value: + * "NEXT_HOP_CANNOT_IP_FORWARD") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceHasNoIpv6Interface + * The route's nextHopInstance URL refers to an instance that does not + * have an ipv6 interface on the same network as the route. (Value: + * "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceNotFound + * The route's nextHopInstance URL refers to an instance that does not + * exist. (Value: "NEXT_HOP_INSTANCE_NOT_FOUND") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopInstanceNotOnNetwork + * The route's nextHopInstance URL refers to an instance that is not on + * the same network as the route. (Value: + * "NEXT_HOP_INSTANCE_NOT_ON_NETWORK") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NextHopNotRunning The + * route's next hop instance does not have a status of RUNNING. (Value: + * "NEXT_HOP_NOT_RUNNING") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NoResultsOnPage No + * results are present on a particular list page. (Value: + * "NO_RESULTS_ON_PAGE") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_NotCriticalError + * Error which is not critical. We decided to continue the process + * despite the mentioned error. (Value: "NOT_CRITICAL_ERROR") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_PartialSuccess + * Success is reported, but some results may be missing due to errors + * (Value: "PARTIAL_SUCCESS") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_QuotaInfoUnavailable + * Quota information is not available to client requests (e.g: + * regions.list). (Value: "QUOTA_INFO_UNAVAILABLE") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_RequiredTosAgreement + * The user attempted to use a resource that requires a TOS they have not + * accepted. (Value: "REQUIRED_TOS_AGREEMENT") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_ResourceInUseByOtherResourceWarning + * Warning that a resource is in use. (Value: + * "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_ResourceNotDeleted + * One or more of the resources set to auto-delete could not be deleted + * because they were in use. (Value: "RESOURCE_NOT_DELETED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_SchemaValidationIgnored + * When a resource schema validation is ignored. (Value: + * "SCHEMA_VALIDATION_IGNORED") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_SingleInstancePropertyTemplate + * Instance template used in instance group manager is valid as such, but + * its application does not make a lot of sense, because it allows only + * single instance in instance group. (Value: + * "SINGLE_INSTANCE_PROPERTY_TEMPLATE") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_UndeclaredProperties + * When undeclared properties in the schema are present (Value: + * "UNDECLARED_PROPERTIES") + * @arg @c kGTLRCompute_PreviewFeatureList_Warning_Code_Unreachable A given + * scope cannot be reached. (Value: "UNREACHABLE") + */ +@property(nonatomic, copy, nullable) NSString *code; + +/** + * [Output Only] Metadata about this warning in key: value format. For example: + * "data": [ { "key": "scope", "value": "zones/us-east1-d" } + */ +@property(nonatomic, strong, nullable) NSArray *data; + +/** [Output Only] A human-readable description of the warning code. */ +@property(nonatomic, copy, nullable) NSString *message; + +@end + + +/** + * GTLRCompute_PreviewFeatureList_Warning_Data_Item + */ +@interface GTLRCompute_PreviewFeatureList_Warning_Data_Item : GTLRObject + +/** + * [Output Only] A key that provides more detail on the warning being returned. + * For example, for warnings where there are no results in a list request for a + * particular zone, this key might be scope and the key value might be the zone + * name. Other examples might be a key indicating a deprecated resource and a + * suggested replacement, or a warning about invalid network settings (for + * example, if an instance attempts to perform IP forwarding but is not enabled + * for IP forwarding). + */ +@property(nonatomic, copy, nullable) NSString *key; + +/** [Output Only] A warning data value corresponding to the key. */ +@property(nonatomic, copy, nullable) NSString *value; + +@end + + +/** + * Represents the rollout operation + */ +@interface GTLRCompute_PreviewFeatureRolloutOperation : GTLRObject + +/** Input only. The input for the rollout operation. */ +@property(nonatomic, strong, nullable) GTLRCompute_PreviewFeatureRolloutOperationRolloutInput *rolloutInput; + +@end + + +/** + * Represents the input for the rollout operation. + */ +@interface GTLRCompute_PreviewFeatureRolloutOperationRolloutInput : GTLRObject + +/** + * The name of the rollout plan Ex. + * organizations//locations/global/rolloutPlans/ Ex. + * folders//locations/global/rolloutPlans/ Ex. + * projects//locations/global/rolloutPlans/. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Predefined rollout plan. + * + * Likely values: + * @arg @c kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanFastRollout + * Value "ROLLOUT_PLAN_FAST_ROLLOUT" + * @arg @c kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanTwoDayRollout + * Value "ROLLOUT_PLAN_TWO_DAY_ROLLOUT" + * @arg @c kGTLRCompute_PreviewFeatureRolloutOperationRolloutInput_PredefinedRolloutPlan_RolloutPlanUnspecified + * Value "ROLLOUT_PLAN_UNSPECIFIED" + */ +@property(nonatomic, copy, nullable) NSString *predefinedRolloutPlan; + +@end + + +/** + * [Output Only] The status of the feature. + */ +@interface GTLRCompute_PreviewFeatureStatus : GTLRObject + +/** + * [Output Only] The description of the feature. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** [Output Only] Link to the public documentation for the feature. */ +@property(nonatomic, copy, nullable) NSString *helpLink; + +@property(nonatomic, strong, nullable) GTLRCompute_PreviewFeatureStatusReleaseStatus *releaseStatus; + +@end + + +/** + * [Output Only] The release status of the feature. + */ +@interface GTLRCompute_PreviewFeatureStatusReleaseStatus : GTLRObject + +/** + * [Output Only] The stage of the feature. + * + * Likely values: + * @arg @c kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Deprecated + * Value "DEPRECATED" + * @arg @c kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Ga Value "GA" + * @arg @c kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_Preview Value + * "PREVIEW" + * @arg @c kGTLRCompute_PreviewFeatureStatusReleaseStatus_Stage_StageUnspecified + * Value "STAGE_UNSPECIFIED" + */ +@property(nonatomic, copy, nullable) NSString *stage; + +/** + * Output only. The last date when a feature transitioned between + * ReleaseStatuses. + */ +@property(nonatomic, strong, nullable) GTLRCompute_Date *updateDate; + +@end + + /** * Represents a Project resource. A project is used to organize resources in a * Google Cloud Platform environment. For more information, read about the @@ -89148,6 +89917,13 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl */ @property(nonatomic, copy, nullable) NSString *backendService; +/** + * The percentage of requests to be mirrored to `backend_service`. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *mirrorPercent; + @end @@ -90776,6 +91552,71 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * GTLRCompute_ReservationSubBlocksReportFaultyRequest + */ +@interface GTLRCompute_ReservationSubBlocksReportFaultyRequest : GTLRObject + +/** + * The disruption schedule for the subBlock. + * + * Likely values: + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequest_DisruptionSchedule_DisruptionScheduleUnspecified + * Value "DISRUPTION_SCHEDULE_UNSPECIFIED" + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequest_DisruptionSchedule_Immediate + * All VMs will be disrupted immediately. (Value: "IMMEDIATE") + */ +@property(nonatomic, copy, nullable) NSString *disruptionSchedule; + +/** + * The component that experienced the fault. + * + * Likely values: + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_FailureComponentUnspecified + * Value "FAILURE_COMPONENT_UNSPECIFIED" + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_MultipleFaultyHosts + * Multiple hosts experienced the fault. (Value: "MULTIPLE_FAULTY_HOSTS") + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequest_FailureComponent_NvlinkSwitch + * The NVLink switch experienced the fault. (Value: "NVLINK_SWITCH") + */ +@property(nonatomic, copy, nullable) NSString *failureComponent; + +/** The reasons for the fault experienced with the subBlock. */ +@property(nonatomic, strong, nullable) NSArray *faultReasons; + +@end + + +/** + * The reason for the fault experienced with the subBlock. + */ +@interface GTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason : GTLRObject + +/** + * The behavior of the fault experienced with the subBlock. + * + * Likely values: + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_FaultBehaviorUnspecified + * Value "FAULT_BEHAVIOR_UNSPECIFIED" + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_GpuError + * The subBlock experienced a GPU error. (Value: "GPU_ERROR") + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_Performance + * The subBlock experienced performance issues. (Value: "PERFORMANCE") + * @arg @c kGTLRCompute_ReservationSubBlocksReportFaultyRequestFaultReason_Behavior_SwitchFailure + * The subBlock experienced a switch failure. (Value: "SWITCH_FAILURE") + */ +@property(nonatomic, copy, nullable) NSString *behavior; + +/** + * The description of the fault experienced with the subBlock. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +@end + + /** * Commitment for a particular hardware resource (a commitment is composed of * one or more of these). @@ -95680,6 +96521,9 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @property(nonatomic, strong, nullable) GTLRCompute_SecurityPolicyAdaptiveProtectionConfig *adaptiveProtectionConfig; @property(nonatomic, strong, nullable) GTLRCompute_SecurityPolicyAdvancedOptionsConfig *advancedOptionsConfig; +/** A list of associations that belong to this policy. */ +@property(nonatomic, strong, nullable) NSArray *associations; + /** [Output Only] Creation timestamp in RFC3339 text format. */ @property(nonatomic, copy, nullable) NSString *creationTimestamp; @@ -95775,6 +96619,19 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl /** [Output Only] Server-defined URL for the resource. */ @property(nonatomic, copy, nullable) NSString *selfLink; +/** + * User-provided name of the organization security policy. The name should be + * unique in the organization in which the security policy is created. This + * should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be + * 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must + * be a lowercase letter, and all following characters must be a dash, + * lowercase letter, or digit, except the last character, which cannot be a + * dash. + */ +@property(nonatomic, copy, nullable) NSString *shortName; + /** * The type indicates the intended use of the security policy. - CLOUD_ARMOR: * Cloud Armor backend security policies can be configured to filter incoming @@ -96040,6 +96897,37 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * GTLRCompute_SecurityPolicyAssociation + */ +@interface GTLRCompute_SecurityPolicyAssociation : GTLRObject + +/** The resource that the security policy is attached to. */ +@property(nonatomic, copy, nullable) NSString *attachmentId; + +/** + * [Output Only] The display name of the security policy of the association. + */ +@property(nonatomic, copy, nullable) NSString *displayName GTLR_DEPRECATED; + +/** A list of folders to exclude from the security policy. */ +@property(nonatomic, strong, nullable) NSArray *excludedFolders; + +/** A list of projects to exclude from the security policy. */ +@property(nonatomic, strong, nullable) NSArray *excludedProjects; + +/** The name for an association. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** [Output Only] The security policy ID of the association. */ +@property(nonatomic, copy, nullable) NSString *securityPolicyId; + +/** [Output Only] The short name of the security policy of the association. */ +@property(nonatomic, copy, nullable) NSString *shortName; + +@end + + /** * GTLRCompute_SecurityPolicyDdosProtectionConfig */ @@ -98141,7 +99029,7 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl /** * Represents a Persistent Disk Snapshot resource. You can use snapshots to * back up data on a regular interval. For more information, read Creating - * persistent disk snapshots. LINT.IfChange + * persistent disk snapshots. */ @interface GTLRCompute_Snapshot : GTLRObject @@ -98301,6 +99189,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl */ @property(nonatomic, copy, nullable) NSString *name; +/** + * Input only. [Input Only] Additional params passed with the request, but not + * persisted as part of resource payload. + */ +@property(nonatomic, strong, nullable) GTLRCompute_SnapshotParams *params; + /** * Output only. Reserved for future use. * @@ -98645,6 +99539,37 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * Additional snapshot params. + */ +@interface GTLRCompute_SnapshotParams : GTLRObject + +/** + * Resource manager tags to be bound to the snapshot. Tag keys and values have + * the same definition as resource manager tags. Keys must be in the format + * `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The + * field is ignored (both PUT & PATCH) when empty. + */ +@property(nonatomic, strong, nullable) GTLRCompute_SnapshotParams_ResourceManagerTags *resourceManagerTags; + +@end + + +/** + * Resource manager tags to be bound to the snapshot. Tag keys and values have + * the same definition as resource manager tags. Keys must be in the format + * `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The + * field is ignored (both PUT & PATCH) when empty. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRCompute_SnapshotParams_ResourceManagerTags : GTLRObject +@end + + /** * GTLRCompute_SnapshotSettings */ @@ -102728,6 +103653,12 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl */ @property(nonatomic, strong, nullable) NSArray *systemReservedInternalIpv6Ranges; +/** + * Output only. [Output Only] The current IP utilization of all subnetwork + * ranges. Contains the total number of allocated and free IPs in each range. + */ +@property(nonatomic, strong, nullable) GTLRCompute_SubnetworkUtilizationDetails *utilizationDetails; + @end @@ -103597,6 +104528,66 @@ FOUNDATION_EXTERN NSString * const kGTLRCompute_ZoneList_Warning_Code_Unreachabl @end +/** + * The current IP utilization of all subnetwork ranges. Contains the total + * number of allocated and free IPs in each range. + */ +@interface GTLRCompute_SubnetworkUtilizationDetails : GTLRObject + +/** Utilizations of external IPV6 IP range. */ +@property(nonatomic, strong, nullable) GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization *externalIpv6InstanceUtilization; + +/** Utilizations of external IPV6 IP range for NetLB. */ +@property(nonatomic, strong, nullable) GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization *externalIpv6LbUtilization; + +/** Utilizations of internal IPV6 IP range. */ +@property(nonatomic, strong, nullable) GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization *internalIpv6Utilization; + +/** + * Utilizations of all IPV4 IP ranges. For primary ranges, the range name will + * be empty. + */ +@property(nonatomic, strong, nullable) NSArray *ipv4Utilizations; + +@end + + +/** + * The IPV4 utilization of a single IP range. + */ +@interface GTLRCompute_SubnetworkUtilizationDetailsIPV4Utilization : GTLRObject + +/** Will be set for secondary range. Empty for primary IPv4 range. */ +@property(nonatomic, copy, nullable) NSString *rangeName; + +/** + * totalAllocatedIp + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalAllocatedIp; + +/** + * totalFreeIp + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalFreeIp; + +@end + + +/** + * The IPV6 utilization of a single IP range. + */ +@interface GTLRCompute_SubnetworkUtilizationDetailsIPV6Utilization : GTLRObject + +@property(nonatomic, strong, nullable) GTLRCompute_Uint128 *totalAllocatedIp; +@property(nonatomic, strong, nullable) GTLRCompute_Uint128 *totalFreeIp; + +@end + + /** * Subsetting configuration for this BackendService. Currently this is * applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load diff --git a/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeQuery.h b/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeQuery.h index 5fda79f11..81b2ad444 100644 --- a/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeQuery.h +++ b/Sources/GeneratedServices/Compute/Public/GoogleAPIClientForREST/GTLRComputeQuery.h @@ -132,6 +132,18 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewBlockViewUnspecified; */ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; +// ---------------------------------------------------------------------------- +// views + +/** Value: "DEFAULT" */ +FOUNDATION_EXTERN NSString * const kGTLRComputeViewsDefault; +/** + * Utilization data is included in the response. + * + * Value: "WITH_UTILIZATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRComputeViewsWithUtilization; + // ---------------------------------------------------------------------------- // Query Classes // @@ -2347,6 +2359,40 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; @end +/** + * Returns effective security policies applied to this backend service. + * + * Method: compute.backendServices.getEffectiveSecurityPolicies + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_BackendServicesGetEffectiveSecurityPolicies : GTLRComputeQuery + +/** Name of the Backend Service for this request. */ +@property(nonatomic, copy, nullable) NSString *backendService; + +/** Project ID for this request. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** + * Upon successful completion, the callback's object and error parameters will + * be nil. This query does not fetch an object. + * + * Returns effective security policies applied to this backend service. + * + * @param project Project ID for this request. + * @param backendService Name of the Backend Service for this request. + * + * @return GTLRComputeQuery_BackendServicesGetEffectiveSecurityPolicies + */ ++ (instancetype)queryWithProject:(NSString *)project + backendService:(NSString *)backendService; + +@end + /** * Gets the most recent health check results for this BackendService. Example * request body: { "group": @@ -26058,17 +26104,825 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; @end /** - * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google - * recommends that you set the `returnPartialSuccess` parameter to `true`. + * Inserts an association for the specified security policy. This has billing + * implications. Projects in the hierarchy with effective hierarchical security + * policies will be automatically enrolled into Cloud Armor Enterprise if not + * already enrolled. Use of this API to modify firewall policies is deprecated. + * Use firewallPolicies.addAssociation instead if possible. * - * Method: compute.packetMirrorings.aggregatedList + * Method: compute.organizationSecurityPolicies.addAssociation + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesAddAssociation : GTLRComputeQuery + +/** + * Indicates whether or not to replace it if an association of the attachment + * already exists. This is false by default, in which case an error will be + * returned if an association already exists. + */ +@property(nonatomic, assign) BOOL replaceExistingAssociation; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Inserts an association for the specified security policy. This has billing + * implications. Projects in the hierarchy with effective hierarchical security + * policies will be automatically enrolled into Cloud Armor Enterprise if not + * already enrolled. Use of this API to modify firewall policies is deprecated. + * Use firewallPolicies.addAssociation instead if possible. + * + * @param object The @c GTLRCompute_SecurityPolicyAssociation to include in the + * query. + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesAddAssociation + */ ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicyAssociation *)object + securityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Inserts a rule into a security policy. + * + * Method: compute.organizationSecurityPolicies.addRule + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesAddRule : GTLRComputeQuery + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Inserts a rule into a security policy. + * + * @param object The @c GTLRCompute_SecurityPolicyRule to include in the query. + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesAddRule + */ ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicyRule *)object + securityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Copies rules to the specified security policy. Use of this API to modify + * firewall policies is deprecated. Use firewallPolicies.copyRules instead. + * + * Method: compute.organizationSecurityPolicies.copyRules + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesCopyRules : GTLRComputeQuery + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** The security policy from which to copy rules. */ +@property(nonatomic, copy, nullable) NSString *sourceSecurityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Copies rules to the specified security policy. Use of this API to modify + * firewall policies is deprecated. Use firewallPolicies.copyRules instead. + * + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesCopyRules + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Deletes the specified policy. Use of this API to remove firewall policies is + * deprecated. Use firewallPolicies.delete instead. + * + * Method: compute.organizationSecurityPolicies.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesDelete : GTLRComputeQuery + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to delete. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Deletes the specified policy. Use of this API to remove firewall policies is + * deprecated. Use firewallPolicies.delete instead. + * + * @param securityPolicy Name of the security policy to delete. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesDelete + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * List all of the ordered rules present in a single specified policy. Use of + * this API to read firewall policies is deprecated. Use firewallPolicies.get + * instead. + * + * Method: compute.organizationSecurityPolicies.get * * Authorization scope(s): * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform * @c kGTLRAuthScopeComputeReadonly */ -@interface GTLRComputeQuery_PacketMirroringsAggregatedList : GTLRComputeQuery +@interface GTLRComputeQuery_OrganizationSecurityPoliciesGet : GTLRComputeQuery + +/** Name of the security policy to get. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_SecurityPolicy. + * + * List all of the ordered rules present in a single specified policy. Use of + * this API to read firewall policies is deprecated. Use firewallPolicies.get + * instead. + * + * @param securityPolicy Name of the security policy to get. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesGet + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Gets an association with the specified name. Use of this API to read + * firewall policies is deprecated. Use firewallPolicies.getAssociation instead + * if possible. + * + * Method: compute.organizationSecurityPolicies.getAssociation + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesGetAssociation : GTLRComputeQuery + +/** The name of the association to get from the security policy. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Name of the security policy to which the queried rule belongs. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_SecurityPolicyAssociation. + * + * Gets an association with the specified name. Use of this API to read + * firewall policies is deprecated. Use firewallPolicies.getAssociation instead + * if possible. + * + * @param securityPolicy Name of the security policy to which the queried rule + * belongs. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesGetAssociation + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Gets a rule at the specified priority. Use of this API to read firewall + * policies is deprecated. Use firewallPolicies.getRule instead. + * + * Method: compute.organizationSecurityPolicies.getRule + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesGetRule : GTLRComputeQuery + +/** The priority of the rule to get from the security policy. */ +@property(nonatomic, assign) NSInteger priority; + +/** Name of the security policy to which the queried rule belongs. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_SecurityPolicyRule. + * + * Gets a rule at the specified priority. Use of this API to read firewall + * policies is deprecated. Use firewallPolicies.getRule instead. + * + * @param securityPolicy Name of the security policy to which the queried rule + * belongs. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesGetRule + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Creates a new policy in the specified project using the data included in the + * request. Use of this API to insert firewall policies is deprecated. Use + * firewallPolicies.insert instead. + * + * Method: compute.organizationSecurityPolicies.insert + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesInsert : GTLRComputeQuery + +/** + * Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if + * the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is + * an organization. + */ +@property(nonatomic, copy, nullable) NSString *parentId; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Creates a new policy in the specified project using the data included in the + * request. Use of this API to insert firewall policies is deprecated. Use + * firewallPolicies.insert instead. + * + * @param object The @c GTLRCompute_SecurityPolicy to include in the query. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesInsert + */ ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicy *)object; + +@end + +/** + * List all the policies that have been configured for the specified project. + * Use of this API to read firewall policies is deprecated. Use + * firewallPolicies.list instead. + * + * Method: compute.organizationSecurityPolicies.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesList : GTLRComputeQuery + +/** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: expressions that + * support regular expressions and expressions that follow API improvement + * proposal AIP-160. These two types of filter expressions cannot be mixed in + * one request. If you want to use AIP-160, your expression must specify the + * field name, an operator, and the value that you want to use for filtering. + * The value must be a string, a number, or a boolean. The operator must be + * either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are + * filtering Compute Engine instances, you can exclude instances named + * `example-instance` by specifying `name != example-instance`. The `:*` + * comparison can be used to test whether a key has been defined. For example, + * to find all objects with `owner` label use: ``` labels.owner:* ``` You can + * also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only if they are + * not scheduled for automatic restarts. You can use filtering on nested fields + * to filter based on resource labels. To filter on multiple expressions, + * provide each separate expression within parentheses. For example: ``` + * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By + * default, each expression is an `AND` expression. However, you can include + * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = + * "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) ``` If you want to use a regular + * expression, use the `eq` (equal) or `ne` (not equal) operator against a + * single un-parenthesized expression with or without quotes or against + * multiple parenthesized expressions. Examples: `fieldname eq unquoted + * literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted + * literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal + * value is interpreted as a regular expression using Google RE2 library + * syntax. The literal value must match the entire field. For example, to + * filter for instances that do not end with name "instance", you would use + * `name ne .*instance`. You cannot combine constraints on multiple fields + * using regular expressions. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than `maxResults`, Compute Engine + * returns a `nextPageToken` that can be used to get the next page of results + * in subsequent list requests. Acceptable values are `0` to `500`, inclusive. + * (Default: `500`) + * + * @note If not set, the documented server-side default will be 500. + */ +@property(nonatomic, assign) NSUInteger maxResults; + +/** + * Sorts list results by a certain order. By default, results are returned in + * alphanumerical order based on the resource name. You can also sort results + * in descending order based on the creation timestamp using + * `orderBy="creationTimestamp desc"`. This sorts results based on the + * `creationTimestamp` field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` + * returned by a previous list request to get the next page of results. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** Parent ID for this request. */ +@property(nonatomic, copy, nullable) NSString *parentId; + +/** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. For example, when partial success + * behavior is enabled, aggregatedList for a single zone scope either returns + * all resources in the zone or no resources, with an error code. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + +/** + * Fetches a @c GTLRCompute_SecurityPolicyList. + * + * List all the policies that have been configured for the specified project. + * Use of this API to read firewall policies is deprecated. Use + * firewallPolicies.list instead. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)query; + +@end + +/** + * Lists associations of a specified target, i.e., organization or folder. Use + * of this API to read firewall policies is deprecated. Use + * firewallPolicies.listAssociations instead if possible. + * + * Method: compute.organizationSecurityPolicies.listAssociations + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesListAssociations : GTLRComputeQuery + +/** + * The target resource to list associations. It is an organization, or a + * folder. + */ +@property(nonatomic, copy, nullable) NSString *targetResource; + +/** + * Fetches a @c + * GTLRCompute_OrganizationSecurityPoliciesListAssociationsResponse. + * + * Lists associations of a specified target, i.e., organization or folder. Use + * of this API to read firewall policies is deprecated. Use + * firewallPolicies.listAssociations instead if possible. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesListAssociations + */ ++ (instancetype)query; + +@end + +/** + * Gets the current list of preconfigured Web Application Firewall (WAF) + * expressions. + * + * Method: compute.organizationSecurityPolicies.listPreconfiguredExpressionSets + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesListPreconfiguredExpressionSets : GTLRComputeQuery + +/** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: expressions that + * support regular expressions and expressions that follow API improvement + * proposal AIP-160. These two types of filter expressions cannot be mixed in + * one request. If you want to use AIP-160, your expression must specify the + * field name, an operator, and the value that you want to use for filtering. + * The value must be a string, a number, or a boolean. The operator must be + * either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are + * filtering Compute Engine instances, you can exclude instances named + * `example-instance` by specifying `name != example-instance`. The `:*` + * comparison can be used to test whether a key has been defined. For example, + * to find all objects with `owner` label use: ``` labels.owner:* ``` You can + * also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only if they are + * not scheduled for automatic restarts. You can use filtering on nested fields + * to filter based on resource labels. To filter on multiple expressions, + * provide each separate expression within parentheses. For example: ``` + * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By + * default, each expression is an `AND` expression. However, you can include + * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = + * "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) ``` If you want to use a regular + * expression, use the `eq` (equal) or `ne` (not equal) operator against a + * single un-parenthesized expression with or without quotes or against + * multiple parenthesized expressions. Examples: `fieldname eq unquoted + * literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted + * literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal + * value is interpreted as a regular expression using Google RE2 library + * syntax. The literal value must match the entire field. For example, to + * filter for instances that do not end with name "instance", you would use + * `name ne .*instance`. You cannot combine constraints on multiple fields + * using regular expressions. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than `maxResults`, Compute Engine + * returns a `nextPageToken` that can be used to get the next page of results + * in subsequent list requests. Acceptable values are `0` to `500`, inclusive. + * (Default: `500`) + * + * @note If not set, the documented server-side default will be 500. + */ +@property(nonatomic, assign) NSUInteger maxResults; + +/** + * Sorts list results by a certain order. By default, results are returned in + * alphanumerical order based on the resource name. You can also sort results + * in descending order based on the creation timestamp using + * `orderBy="creationTimestamp desc"`. This sorts results based on the + * `creationTimestamp` field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` + * returned by a previous list request to get the next page of results. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** Parent ID for this request. */ +@property(nonatomic, copy, nullable) NSString *parentId; + +/** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. For example, when partial success + * behavior is enabled, aggregatedList for a single zone scope either returns + * all resources in the zone or no resources, with an error code. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + +/** + * Fetches a @c + * GTLRCompute_SecurityPoliciesListPreconfiguredExpressionSetsResponse. + * + * Gets the current list of preconfigured Web Application Firewall (WAF) + * expressions. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesListPreconfiguredExpressionSets + */ ++ (instancetype)query; + +@end + +/** + * Moves the specified security policy. Use of this API to modify firewall + * policies is deprecated. Use firewallPolicies.move instead. + * + * Method: compute.organizationSecurityPolicies.move + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesMove : GTLRComputeQuery + +/** The new parent of the security policy. */ +@property(nonatomic, copy, nullable) NSString *parentId; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Moves the specified security policy. Use of this API to modify firewall + * policies is deprecated. Use firewallPolicies.move instead. + * + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesMove + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Patches the specified policy with the data included in the request. Use of + * this API to modify firewall policies is deprecated. Use + * firewallPolicies.patch instead. + * + * Method: compute.organizationSecurityPolicies.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesPatch : GTLRComputeQuery + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Patches the specified policy with the data included in the request. Use of + * this API to modify firewall policies is deprecated. Use + * firewallPolicies.patch instead. + * + * @param object The @c GTLRCompute_SecurityPolicy to include in the query. + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesPatch + */ ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicy *)object + securityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Patches a rule at the specified priority. Use of this API to modify firewall + * policies is deprecated. Use firewallPolicies.patchRule instead. + * + * Method: compute.organizationSecurityPolicies.patchRule + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesPatchRule : GTLRComputeQuery + +/** The priority of the rule to patch. */ +@property(nonatomic, assign) NSInteger priority; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Patches a rule at the specified priority. Use of this API to modify firewall + * policies is deprecated. Use firewallPolicies.patchRule instead. + * + * @param object The @c GTLRCompute_SecurityPolicyRule to include in the query. + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesPatchRule + */ ++ (instancetype)queryWithObject:(GTLRCompute_SecurityPolicyRule *)object + securityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Removes an association for the specified security policy. Use of this API to + * modify firewall policies is deprecated. Use + * firewallPolicies.removeAssociation instead if possible. + * + * Method: compute.organizationSecurityPolicies.removeAssociation + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesRemoveAssociation : GTLRComputeQuery + +/** Name for the attachment that will be removed. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Removes an association for the specified security policy. Use of this API to + * modify firewall policies is deprecated. Use + * firewallPolicies.removeAssociation instead if possible. + * + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesRemoveAssociation + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Deletes a rule at the specified priority. + * + * Method: compute.organizationSecurityPolicies.removeRule + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_OrganizationSecurityPoliciesRemoveRule : GTLRComputeQuery + +/** The priority of the rule to remove from the security policy. */ +@property(nonatomic, assign) NSInteger priority; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** Name of the security policy to update. */ +@property(nonatomic, copy, nullable) NSString *securityPolicy; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Deletes a rule at the specified priority. + * + * @param securityPolicy Name of the security policy to update. + * + * @return GTLRComputeQuery_OrganizationSecurityPoliciesRemoveRule + */ ++ (instancetype)queryWithSecurityPolicy:(NSString *)securityPolicy; + +@end + +/** + * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google + * recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * Method: compute.packetMirrorings.aggregatedList + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_PacketMirroringsAggregatedList : GTLRComputeQuery /** * A filter expression that filters resources listed in the response. Most @@ -26158,37 +27012,288 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; @property(nonatomic, assign) BOOL returnPartialSuccess; /** - * The Shared VPC service project id or service project number for which - * aggregated list request is invoked for subnetworks list-usable api. - */ -@property(nonatomic, assign) long long serviceProjectNumber; - -/** - * Fetches a @c GTLRCompute_PacketMirroringAggregatedList. + * The Shared VPC service project id or service project number for which + * aggregated list request is invoked for subnetworks list-usable api. + */ +@property(nonatomic, assign) long long serviceProjectNumber; + +/** + * Fetches a @c GTLRCompute_PacketMirroringAggregatedList. + * + * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google + * recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param project Project ID for this request. + * + * @return GTLRComputeQuery_PacketMirroringsAggregatedList + */ ++ (instancetype)queryWithProject:(NSString *)project; + +@end + +/** + * Deletes the specified PacketMirroring resource. + * + * Method: compute.packetMirrorings.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_PacketMirroringsDelete : GTLRComputeQuery + +/** Name of the PacketMirroring resource to delete. */ +@property(nonatomic, copy, nullable) NSString *packetMirroring; + +/** Project ID for this request. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** Name of the region for this request. */ +@property(nonatomic, copy, nullable) NSString *region; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Deletes the specified PacketMirroring resource. + * + * @param project Project ID for this request. + * @param region Name of the region for this request. + * @param packetMirroring Name of the PacketMirroring resource to delete. + * + * @return GTLRComputeQuery_PacketMirroringsDelete + */ ++ (instancetype)queryWithProject:(NSString *)project + region:(NSString *)region + packetMirroring:(NSString *)packetMirroring; + +@end + +/** + * Returns the specified PacketMirroring resource. + * + * Method: compute.packetMirrorings.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_PacketMirroringsGet : GTLRComputeQuery + +/** Name of the PacketMirroring resource to return. */ +@property(nonatomic, copy, nullable) NSString *packetMirroring; + +/** Project ID for this request. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** Name of the region for this request. */ +@property(nonatomic, copy, nullable) NSString *region; + +/** + * Fetches a @c GTLRCompute_PacketMirroring. + * + * Returns the specified PacketMirroring resource. + * + * @param project Project ID for this request. + * @param region Name of the region for this request. + * @param packetMirroring Name of the PacketMirroring resource to return. + * + * @return GTLRComputeQuery_PacketMirroringsGet + */ ++ (instancetype)queryWithProject:(NSString *)project + region:(NSString *)region + packetMirroring:(NSString *)packetMirroring; + +@end + +/** + * Creates a PacketMirroring resource in the specified project and region using + * the data included in the request. + * + * Method: compute.packetMirrorings.insert + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_PacketMirroringsInsert : GTLRComputeQuery + +/** Project ID for this request. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** Name of the region for this request. */ +@property(nonatomic, copy, nullable) NSString *region; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Creates a PacketMirroring resource in the specified project and region using + * the data included in the request. + * + * @param object The @c GTLRCompute_PacketMirroring to include in the query. + * @param project Project ID for this request. + * @param region Name of the region for this request. + * + * @return GTLRComputeQuery_PacketMirroringsInsert + */ ++ (instancetype)queryWithObject:(GTLRCompute_PacketMirroring *)object + project:(NSString *)project + region:(NSString *)region; + +@end + +/** + * Retrieves a list of PacketMirroring resources available to the specified + * project and region. + * + * Method: compute.packetMirrorings.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly + */ +@interface GTLRComputeQuery_PacketMirroringsList : GTLRComputeQuery + +/** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: expressions that + * support regular expressions and expressions that follow API improvement + * proposal AIP-160. These two types of filter expressions cannot be mixed in + * one request. If you want to use AIP-160, your expression must specify the + * field name, an operator, and the value that you want to use for filtering. + * The value must be a string, a number, or a boolean. The operator must be + * either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are + * filtering Compute Engine instances, you can exclude instances named + * `example-instance` by specifying `name != example-instance`. The `:*` + * comparison can be used to test whether a key has been defined. For example, + * to find all objects with `owner` label use: ``` labels.owner:* ``` You can + * also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only if they are + * not scheduled for automatic restarts. You can use filtering on nested fields + * to filter based on resource labels. To filter on multiple expressions, + * provide each separate expression within parentheses. For example: ``` + * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By + * default, each expression is an `AND` expression. However, you can include + * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = + * "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) ``` If you want to use a regular + * expression, use the `eq` (equal) or `ne` (not equal) operator against a + * single un-parenthesized expression with or without quotes or against + * multiple parenthesized expressions. Examples: `fieldname eq unquoted + * literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted + * literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal + * value is interpreted as a regular expression using Google RE2 library + * syntax. The literal value must match the entire field. For example, to + * filter for instances that do not end with name "instance", you would use + * `name ne .*instance`. You cannot combine constraints on multiple fields + * using regular expressions. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than `maxResults`, Compute Engine + * returns a `nextPageToken` that can be used to get the next page of results + * in subsequent list requests. Acceptable values are `0` to `500`, inclusive. + * (Default: `500`) + * + * @note If not set, the documented server-side default will be 500. + */ +@property(nonatomic, assign) NSUInteger maxResults; + +/** + * Sorts list results by a certain order. By default, results are returned in + * alphanumerical order based on the resource name. You can also sort results + * in descending order based on the creation timestamp using + * `orderBy="creationTimestamp desc"`. This sorts results based on the + * `creationTimestamp` field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` + * returned by a previous list request to get the next page of results. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** Project ID for this request. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** Name of the region for this request. */ +@property(nonatomic, copy, nullable) NSString *region; + +/** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. For example, when partial success + * behavior is enabled, aggregatedList for a single zone scope either returns + * all resources in the zone or no resources, with an error code. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + +/** + * Fetches a @c GTLRCompute_PacketMirroringList. * - * Retrieves an aggregated list of packetMirrorings. To prevent failure, Google - * recommends that you set the `returnPartialSuccess` parameter to `true`. + * Retrieves a list of PacketMirroring resources available to the specified + * project and region. * * @param project Project ID for this request. + * @param region Name of the region for this request. * - * @return GTLRComputeQuery_PacketMirroringsAggregatedList + * @return GTLRComputeQuery_PacketMirroringsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. */ -+ (instancetype)queryWithProject:(NSString *)project; ++ (instancetype)queryWithProject:(NSString *)project + region:(NSString *)region; @end /** - * Deletes the specified PacketMirroring resource. + * Patches the specified PacketMirroring resource with the data included in the + * request. This method supports PATCH semantics and uses JSON merge patch + * format and processing rules. * - * Method: compute.packetMirrorings.delete + * Method: compute.packetMirrorings.patch * * Authorization scope(s): * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform */ -@interface GTLRComputeQuery_PacketMirroringsDelete : GTLRComputeQuery +@interface GTLRComputeQuery_PacketMirroringsPatch : GTLRComputeQuery -/** Name of the PacketMirroring resource to delete. */ +/** Name of the PacketMirroring resource to patch. */ @property(nonatomic, copy, nullable) NSString *packetMirroring; /** Project ID for this request. */ @@ -26213,119 +27318,109 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; /** * Fetches a @c GTLRCompute_Operation. * - * Deletes the specified PacketMirroring resource. + * Patches the specified PacketMirroring resource with the data included in the + * request. This method supports PATCH semantics and uses JSON merge patch + * format and processing rules. * + * @param object The @c GTLRCompute_PacketMirroring to include in the query. * @param project Project ID for this request. * @param region Name of the region for this request. - * @param packetMirroring Name of the PacketMirroring resource to delete. + * @param packetMirroring Name of the PacketMirroring resource to patch. * - * @return GTLRComputeQuery_PacketMirroringsDelete + * @return GTLRComputeQuery_PacketMirroringsPatch */ -+ (instancetype)queryWithProject:(NSString *)project - region:(NSString *)region - packetMirroring:(NSString *)packetMirroring; ++ (instancetype)queryWithObject:(GTLRCompute_PacketMirroring *)object + project:(NSString *)project + region:(NSString *)region + packetMirroring:(NSString *)packetMirroring; @end /** - * Returns the specified PacketMirroring resource. + * Returns permissions that a caller has on the specified resource. * - * Method: compute.packetMirrorings.get + * Method: compute.packetMirrorings.testIamPermissions * * Authorization scope(s): * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform * @c kGTLRAuthScopeComputeReadonly */ -@interface GTLRComputeQuery_PacketMirroringsGet : GTLRComputeQuery - -/** Name of the PacketMirroring resource to return. */ -@property(nonatomic, copy, nullable) NSString *packetMirroring; +@interface GTLRComputeQuery_PacketMirroringsTestIamPermissions : GTLRComputeQuery /** Project ID for this request. */ @property(nonatomic, copy, nullable) NSString *project; -/** Name of the region for this request. */ +/** The name of the region for this request. */ @property(nonatomic, copy, nullable) NSString *region; +/** Name or id of the resource for this request. */ +@property(nonatomic, copy, nullable) NSString *resource; + /** - * Fetches a @c GTLRCompute_PacketMirroring. + * Fetches a @c GTLRCompute_TestPermissionsResponse. * - * Returns the specified PacketMirroring resource. + * Returns permissions that a caller has on the specified resource. * + * @param object The @c GTLRCompute_TestPermissionsRequest to include in the + * query. * @param project Project ID for this request. - * @param region Name of the region for this request. - * @param packetMirroring Name of the PacketMirroring resource to return. + * @param region The name of the region for this request. + * @param resource Name or id of the resource for this request. * - * @return GTLRComputeQuery_PacketMirroringsGet + * @return GTLRComputeQuery_PacketMirroringsTestIamPermissions */ -+ (instancetype)queryWithProject:(NSString *)project - region:(NSString *)region - packetMirroring:(NSString *)packetMirroring; ++ (instancetype)queryWithObject:(GTLRCompute_TestPermissionsRequest *)object + project:(NSString *)project + region:(NSString *)region + resource:(NSString *)resource; @end /** - * Creates a PacketMirroring resource in the specified project and region using - * the data included in the request. + * Returns the details of the given PreviewFeature. * - * Method: compute.packetMirrorings.insert + * Method: compute.previewFeatures.get * * Authorization scope(s): * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform + * @c kGTLRAuthScopeComputeReadonly */ -@interface GTLRComputeQuery_PacketMirroringsInsert : GTLRComputeQuery +@interface GTLRComputeQuery_PreviewFeaturesGet : GTLRComputeQuery + +/** Name of the PreviewFeature for this request. */ +@property(nonatomic, copy, nullable) NSString *previewFeature; /** Project ID for this request. */ @property(nonatomic, copy, nullable) NSString *project; -/** Name of the region for this request. */ -@property(nonatomic, copy, nullable) NSString *region; - -/** - * An optional request ID to identify requests. Specify a unique request ID so - * that if you must retry your request, the server will know to ignore the - * request if it has already been completed. For example, consider a situation - * where you make an initial request and the request times out. If you make the - * request again with the same request ID, the server can check if original - * operation with the same request ID was received, and if so, will ignore the - * second request. This prevents clients from accidentally creating duplicate - * commitments. The request ID must be a valid UUID with the exception that - * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ -@property(nonatomic, copy, nullable) NSString *requestId; - /** - * Fetches a @c GTLRCompute_Operation. + * Fetches a @c GTLRCompute_PreviewFeature. * - * Creates a PacketMirroring resource in the specified project and region using - * the data included in the request. + * Returns the details of the given PreviewFeature. * - * @param object The @c GTLRCompute_PacketMirroring to include in the query. * @param project Project ID for this request. - * @param region Name of the region for this request. + * @param previewFeature Name of the PreviewFeature for this request. * - * @return GTLRComputeQuery_PacketMirroringsInsert + * @return GTLRComputeQuery_PreviewFeaturesGet */ -+ (instancetype)queryWithObject:(GTLRCompute_PacketMirroring *)object - project:(NSString *)project - region:(NSString *)region; ++ (instancetype)queryWithProject:(NSString *)project + previewFeature:(NSString *)previewFeature; @end /** - * Retrieves a list of PacketMirroring resources available to the specified - * project and region. + * Returns the details of the given PreviewFeature. * - * Method: compute.packetMirrorings.list + * Method: compute.previewFeatures.list * * Authorization scope(s): * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform * @c kGTLRAuthScopeComputeReadonly */ -@interface GTLRComputeQuery_PacketMirroringsList : GTLRComputeQuery +@interface GTLRComputeQuery_PreviewFeaturesList : GTLRComputeQuery /** * A filter expression that filters resources listed in the response. Most @@ -26395,9 +27490,6 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; /** Project ID for this request. */ @property(nonatomic, copy, nullable) NSString *project; -/** Name of the region for this request. */ -@property(nonatomic, copy, nullable) NSString *region; - /** * Opt-in for partial success behavior which provides partial results in case * of failure. The default value is false. For example, when partial success @@ -26407,47 +27499,40 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; @property(nonatomic, assign) BOOL returnPartialSuccess; /** - * Fetches a @c GTLRCompute_PacketMirroringList. + * Fetches a @c GTLRCompute_PreviewFeatureList. * - * Retrieves a list of PacketMirroring resources available to the specified - * project and region. + * Returns the details of the given PreviewFeature. * * @param project Project ID for this request. - * @param region Name of the region for this request. * - * @return GTLRComputeQuery_PacketMirroringsList + * @return GTLRComputeQuery_PreviewFeaturesList * * @note Automatic pagination will be done when @c shouldFetchNextPages is * enabled. See @c shouldFetchNextPages on @c GTLRService for more * information. */ -+ (instancetype)queryWithProject:(NSString *)project - region:(NSString *)region; ++ (instancetype)queryWithProject:(NSString *)project; @end /** - * Patches the specified PacketMirroring resource with the data included in the - * request. This method supports PATCH semantics and uses JSON merge patch - * format and processing rules. + * Patches the given PreviewFeature. This method is used to enable or disable a + * PreviewFeature. * - * Method: compute.packetMirrorings.patch + * Method: compute.previewFeatures.update * * Authorization scope(s): * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform */ -@interface GTLRComputeQuery_PacketMirroringsPatch : GTLRComputeQuery +@interface GTLRComputeQuery_PreviewFeaturesUpdate : GTLRComputeQuery -/** Name of the PacketMirroring resource to patch. */ -@property(nonatomic, copy, nullable) NSString *packetMirroring; +/** Name of the PreviewFeature for this request. */ +@property(nonatomic, copy, nullable) NSString *previewFeature; /** Project ID for this request. */ @property(nonatomic, copy, nullable) NSString *project; -/** Name of the region for this request. */ -@property(nonatomic, copy, nullable) NSString *region; - /** * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the @@ -26464,62 +27549,18 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; /** * Fetches a @c GTLRCompute_Operation. * - * Patches the specified PacketMirroring resource with the data included in the - * request. This method supports PATCH semantics and uses JSON merge patch - * format and processing rules. + * Patches the given PreviewFeature. This method is used to enable or disable a + * PreviewFeature. * - * @param object The @c GTLRCompute_PacketMirroring to include in the query. + * @param object The @c GTLRCompute_PreviewFeature to include in the query. * @param project Project ID for this request. - * @param region Name of the region for this request. - * @param packetMirroring Name of the PacketMirroring resource to patch. + * @param previewFeature Name of the PreviewFeature for this request. * - * @return GTLRComputeQuery_PacketMirroringsPatch + * @return GTLRComputeQuery_PreviewFeaturesUpdate */ -+ (instancetype)queryWithObject:(GTLRCompute_PacketMirroring *)object ++ (instancetype)queryWithObject:(GTLRCompute_PreviewFeature *)object project:(NSString *)project - region:(NSString *)region - packetMirroring:(NSString *)packetMirroring; - -@end - -/** - * Returns permissions that a caller has on the specified resource. - * - * Method: compute.packetMirrorings.testIamPermissions - * - * Authorization scope(s): - * @c kGTLRAuthScopeCompute - * @c kGTLRAuthScopeComputeCloudPlatform - * @c kGTLRAuthScopeComputeReadonly - */ -@interface GTLRComputeQuery_PacketMirroringsTestIamPermissions : GTLRComputeQuery - -/** Project ID for this request. */ -@property(nonatomic, copy, nullable) NSString *project; - -/** The name of the region for this request. */ -@property(nonatomic, copy, nullable) NSString *region; - -/** Name or id of the resource for this request. */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRCompute_TestPermissionsResponse. - * - * Returns permissions that a caller has on the specified resource. - * - * @param object The @c GTLRCompute_TestPermissionsRequest to include in the - * query. - * @param project Project ID for this request. - * @param region The name of the region for this request. - * @param resource Name or id of the resource for this request. - * - * @return GTLRComputeQuery_PacketMirroringsTestIamPermissions - */ -+ (instancetype)queryWithObject:(GTLRCompute_TestPermissionsRequest *)object - project:(NSString *)project - region:(NSString *)region - resource:(NSString *)resource; + previewFeature:(NSString *)previewFeature; @end @@ -26976,7 +28017,14 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; @end /** - * Moves a persistent disk from one zone to another. + * Starting September 29, 2025, you can't use the moveDisk API on new projects. + * To move a disk to a different region or zone, follow the steps in [Change + * the location of a + * disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). + * Projects that already use the moveDisk API can continue usage until + * September 29, 2026. Starting November 1, 2025, API responses will include a + * warning message in the response body about the upcoming deprecation. You can + * skip the message to continue using the service without interruption. * * Method: compute.projects.moveDisk * @@ -26984,6 +28032,7 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; * @c kGTLRAuthScopeCompute * @c kGTLRAuthScopeComputeCloudPlatform */ +GTLR_DEPRECATED @interface GTLRComputeQuery_ProjectsMoveDisk : GTLRComputeQuery /** Project ID for this request. */ @@ -27005,7 +28054,14 @@ FOUNDATION_EXTERN NSString * const kGTLRComputeViewFull; /** * Fetches a @c GTLRCompute_Operation. * - * Moves a persistent disk from one zone to another. + * Starting September 29, 2025, you can't use the moveDisk API on new projects. + * To move a disk to a different region or zone, follow the steps in [Change + * the location of a + * disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). + * Projects that already use the moveDisk API can continue usage until + * September 29, 2026. Starting November 1, 2025, API responses will include a + * warning message in the response body about the upcoming deprecation. You can + * skip the message to continue using the service without interruption. * * @param object The @c GTLRCompute_DiskMoveRequest to include in the query. * @param project Project ID for this request. @@ -40135,6 +41191,78 @@ GTLR_DEPRECATED @end +/** + * Allows customers to report a faulty subBlock. + * + * Method: compute.reservationSubBlocks.reportFaulty + * + * Authorization scope(s): + * @c kGTLRAuthScopeCompute + * @c kGTLRAuthScopeComputeCloudPlatform + */ +@interface GTLRComputeQuery_ReservationSubBlocksReportFaulty : GTLRComputeQuery + +/** + * The name of the parent reservation and parent block. In the format of + * reservations/{reservation_name}/reservationBlocks/{reservation_block_name} + */ +@property(nonatomic, copy, nullable) NSString *parentName; + +/** Project ID for this request. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. For example, consider a situation + * where you make an initial request and the request times out. If you make the + * request again with the same request ID, the server can check if original + * operation with the same request ID was received, and if so, will ignore the + * second request. This prevents clients from accidentally creating duplicate + * commitments. The request ID must be a valid UUID with the exception that + * zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * The name of the reservation subBlock. Name should conform to RFC1035 or be a + * resource ID. + */ +@property(nonatomic, copy, nullable) NSString *reservationSubBlock; + +/** + * Name of the zone for this request. Zone name should conform to RFC1035. + * + * Remapped to 'zoneProperty' to avoid NSObject's 'zone'. + */ +@property(nonatomic, copy, nullable) NSString *zoneProperty; + +/** + * Fetches a @c GTLRCompute_Operation. + * + * Allows customers to report a faulty subBlock. + * + * @param object The @c GTLRCompute_ReservationSubBlocksReportFaultyRequest to + * include in the query. + * @param project Project ID for this request. + * @param zoneProperty Name of the zone for this request. Zone name should + * conform to RFC1035. + * @param parentName The name of the parent reservation and parent block. In + * the format of + * reservations/{reservation_name}/reservationBlocks/{reservation_block_name} + * @param reservationSubBlock The name of the reservation subBlock. Name should + * conform to RFC1035 or be a resource ID. + * + * @return GTLRComputeQuery_ReservationSubBlocksReportFaulty + */ ++ (instancetype)queryWithObject:(GTLRCompute_ReservationSubBlocksReportFaultyRequest *)object + project:(NSString *)project + zoneProperty:(NSString *)zoneProperty + parentName:(NSString *)parentName + reservationSubBlock:(NSString *)reservationSubBlock; + +@end + /** * Update share settings of the reservation. * @@ -46043,6 +47171,17 @@ GTLR_DEPRECATED /** Name of the Subnetwork resource to return. */ @property(nonatomic, copy, nullable) NSString *subnetwork; +/** + * Defines the extra views returned back in the subnetwork resource. Supported + * values: - WITH_UTILIZATION: Utilization data is included in the response. + * + * Likely values: + * @arg @c kGTLRComputeViewsDefault Value "DEFAULT" + * @arg @c kGTLRComputeViewsWithUtilization Utilization data is included in + * the response. (Value: "WITH_UTILIZATION") + */ +@property(nonatomic, strong, nullable) NSArray *views; + /** * Fetches a @c GTLRCompute_Subnetwork. * @@ -46243,6 +47382,17 @@ GTLR_DEPRECATED */ @property(nonatomic, assign) BOOL returnPartialSuccess; +/** + * Defines the extra views returned back in the subnetwork resource. Supported + * values: - WITH_UTILIZATION: Utilization data is included in the response. + * + * Likely values: + * @arg @c kGTLRComputeViewsDefault Value "DEFAULT" + * @arg @c kGTLRComputeViewsWithUtilization Utilization data is included in + * the response. (Value: "WITH_UTILIZATION") + */ +@property(nonatomic, strong, nullable) NSArray *views; + /** * Fetches a @c GTLRCompute_SubnetworkList. * diff --git a/Sources/GeneratedServices/Config/GTLRConfigObjects.m b/Sources/GeneratedServices/Config/GTLRConfigObjects.m index 99b6e3f30..115f8ec2c 100644 --- a/Sources/GeneratedServices/Config/GTLRConfigObjects.m +++ b/Sources/GeneratedServices/Config/GTLRConfigObjects.m @@ -451,11 +451,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRConfig_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRConfig_Operation class] + @"operations" : [GTLRConfig_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Config/GTLRConfigQuery.m b/Sources/GeneratedServices/Config/GTLRConfigQuery.m index 4085fa773..f9108384e 100644 --- a/Sources/GeneratedServices/Config/GTLRConfigQuery.m +++ b/Sources/GeneratedServices/Config/GTLRConfigQuery.m @@ -585,7 +585,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRConfigQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigObjects.h b/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigObjects.h index f21fd5b46..e6d6a725e 100644 --- a/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigObjects.h +++ b/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigObjects.h @@ -1553,6 +1553,13 @@ FOUNDATION_EXTERN NSString * const kGTLRConfig_TerraformVersion_State_StateUnspe */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigQuery.h b/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigQuery.h index fa9c74116..7cecbe08b 100644 --- a/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigQuery.h +++ b/Sources/GeneratedServices/Config/Public/GoogleAPIClientForREST/GTLRConfigQuery.h @@ -930,8 +930,8 @@ FOUNDATION_EXTERN NSString * const kGTLRConfigDeletePolicyDeletePolicyUnspecifie @interface GTLRConfigQuery_ProjectsLocationsList : GTLRConfigQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -1104,6 +1104,17 @@ FOUNDATION_EXTERN NSString * const kGTLRConfigDeletePolicyDeletePolicyUnspecifie /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRConfig_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Connectors/GTLRConnectorsObjects.m b/Sources/GeneratedServices/Connectors/GTLRConnectorsObjects.m index 6ebc3ffa7..c1b503ebf 100644 --- a/Sources/GeneratedServices/Connectors/GTLRConnectorsObjects.m +++ b/Sources/GeneratedServices/Connectors/GTLRConnectorsObjects.m @@ -1479,7 +1479,8 @@ @implementation GTLRConnectors_TimeOfDay // @implementation GTLRConnectors_Tool -@dynamic dependsOn, descriptionProperty, inputSchema, name, outputSchema; +@dynamic annotations, dependsOn, descriptionProperty, inputSchema, name, + outputSchema; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"descriptionProperty" : @"description" }; @@ -1495,6 +1496,16 @@ @implementation GTLRConnectors_Tool @end +// ---------------------------------------------------------------------------- +// +// GTLRConnectors_ToolAnnotations +// + +@implementation GTLRConnectors_ToolAnnotations +@dynamic destructiveHint, idempotentHint, openWorldHint, readOnlyHint, title; +@end + + // ---------------------------------------------------------------------------- // // GTLRConnectors_UpdateEntitiesWithConditionsResponse diff --git a/Sources/GeneratedServices/Connectors/Public/GoogleAPIClientForREST/GTLRConnectorsObjects.h b/Sources/GeneratedServices/Connectors/Public/GoogleAPIClientForREST/GTLRConnectorsObjects.h index 38f6aa217..c9d828110 100644 --- a/Sources/GeneratedServices/Connectors/Public/GoogleAPIClientForREST/GTLRConnectorsObjects.h +++ b/Sources/GeneratedServices/Connectors/Public/GoogleAPIClientForREST/GTLRConnectorsObjects.h @@ -82,6 +82,7 @@ @class GTLRConnectors_SloMetadata; @class GTLRConnectors_TimeOfDay; @class GTLRConnectors_Tool; +@class GTLRConnectors_ToolAnnotations; @class GTLRConnectors_UpdateEntitiesWithConditionsResponse_Metadata; @class GTLRConnectors_UpdateEntitiesWithConditionsResponse_Metadata_Metadata; @class GTLRConnectors_UpdateEntitiesWithConditionsResponse_Response; @@ -4035,6 +4036,9 @@ FOUNDATION_EXTERN NSString * const kGTLRConnectors_UpdatePolicy_Channel_Week5; */ @interface GTLRConnectors_Tool : GTLRObject +/** Annotations for the tool. */ +@property(nonatomic, strong, nullable) GTLRConnectors_ToolAnnotations *annotations; + /** List of tool names that this tool depends on. */ @property(nonatomic, strong, nullable) NSArray *dependsOn; @@ -4057,6 +4061,51 @@ FOUNDATION_EXTERN NSString * const kGTLRConnectors_UpdatePolicy_Channel_Week5; @end +/** + * ToolAnnotations holds annotations for a tool. + */ +@interface GTLRConnectors_ToolAnnotations : GTLRObject + +/** + * If true, the tool may perform destructive updates to its environment. If + * false, the tool performs only additive updates. (This property is meaningful + * only when `read_only_hint == false`) + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *destructiveHint; + +/** + * If true, calling the tool repeatedly with the same arguments will have no + * additional effect on the environment. (This property is meaningful only when + * `read_only_hint == false`) + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *idempotentHint; + +/** + * If true, this tool may interact with an "open world" of external entities. + * If false, the tool's domain of interaction is closed. For example, the world + * of a web search tool is open, whereas that of a memory tool is not. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *openWorldHint; + +/** + * If true, the tool does not modify its environment. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *readOnlyHint; + +/** A human-readable title for the tool. */ +@property(nonatomic, copy, nullable) NSString *title; + +@end + + /** * Response message for EntityService.UpdateEntitiesWithConditions */ diff --git a/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsObjects.m b/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsObjects.m index 64f178621..1c5316445 100644 --- a/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsObjects.m +++ b/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsObjects.m @@ -48,7 +48,9 @@ // GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension.dimensionKey NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_Agent = @"AGENT"; +NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentDeploymentId = @"AGENT_DEPLOYMENT_ID"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentTeam = @"AGENT_TEAM"; +NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentVersionId = @"AGENT_VERSION_ID"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_ConversationProfileId = @"CONVERSATION_PROFILE_ID"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_DimensionKeyUnspecified = @"DIMENSION_KEY_UNSPECIFIED"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_Issue = @"ISSUE"; @@ -82,6 +84,7 @@ NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportSchemaVersionUnspecified = @"EXPORT_SCHEMA_VERSION_UNSPECIFIED"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV1 = @"EXPORT_V1"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV10 = @"EXPORT_V10"; +NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV11 = @"EXPORT_V11"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV2 = @"EXPORT_V2"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV3 = @"EXPORT_V3"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV4 = @"EXPORT_V4"; @@ -200,7 +203,9 @@ // GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension.dimensionKey NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_Agent = @"AGENT"; +NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentDeploymentId = @"AGENT_DEPLOYMENT_ID"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentTeam = @"AGENT_TEAM"; +NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentVersionId = @"AGENT_VERSION_ID"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_ConversationProfileId = @"CONVERSATION_PROFILE_ID"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_DimensionKeyUnspecified = @"DIMENSION_KEY_UNSPECIFIED"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_Issue = @"ISSUE"; @@ -234,6 +239,7 @@ NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportSchemaVersionUnspecified = @"EXPORT_SCHEMA_VERSION_UNSPECIFIED"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV1 = @"EXPORT_V1"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV10 = @"EXPORT_V10"; +NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV11 = @"EXPORT_V11"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV2 = @"EXPORT_V2"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV3 = @"EXPORT_V3"; NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV4 = @"EXPORT_V4"; @@ -800,8 +806,8 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alph // @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo -@dynamic agentId, agentType, displayName, dispositionCode, location, team, - teams; +@dynamic agentId, agentType, deploymentDisplayName, deploymentId, displayName, + dispositionCode, location, team, teams, versionDisplayName, versionId; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -1081,7 +1087,8 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alph @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension @dynamic agentDimensionMetadata, dimensionKey, issueDimensionMetadata, - qaQuestionAnswerDimensionMetadata, qaQuestionDimensionMetadata; + qaQuestionAnswerDimensionMetadata, qaQuestionDimensionMetadata, + qaScorecardDimensionMetadata; @end @@ -1091,7 +1098,8 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alph // @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata -@dynamic agentDisplayName, agentId, agentTeam; +@dynamic agentDeploymentDisplayName, agentDeploymentId, agentDisplayName, + agentId, agentTeam, agentVersionDisplayName, agentVersionId; @end @@ -1125,6 +1133,16 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alph @end +// ---------------------------------------------------------------------------- +// +// GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata +// + +@implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata +@dynamic qaScorecardId; +@end + + // ---------------------------------------------------------------------------- // // GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec @@ -1714,7 +1732,17 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alph @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue @dynamic boolValue, key, naValue, normalizedScore, numValue, potentialScore, - score, skipValue, strValue; + rationale, score, skipValue, strValue; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale +// + +@implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale +@dynamic rationale; @end @@ -2880,8 +2908,8 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Conv // @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo -@dynamic agentId, agentType, displayName, dispositionCode, location, team, - teams; +@dynamic agentId, agentType, deploymentDisplayName, deploymentId, displayName, + dispositionCode, location, team, teams, versionDisplayName, versionId; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -3170,7 +3198,8 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dial @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension @dynamic agentDimensionMetadata, dimensionKey, issueDimensionMetadata, - qaQuestionAnswerDimensionMetadata, qaQuestionDimensionMetadata; + qaQuestionAnswerDimensionMetadata, qaQuestionDimensionMetadata, + qaScorecardDimensionMetadata; @end @@ -3180,7 +3209,8 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dime // @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata -@dynamic agentDisplayName, agentId, agentTeam; +@dynamic agentDeploymentDisplayName, agentDeploymentId, agentDisplayName, + agentId, agentTeam, agentVersionDisplayName, agentVersionId; @end @@ -3214,6 +3244,16 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dime @end +// ---------------------------------------------------------------------------- +// +// GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata +// + +@implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata +@dynamic qaScorecardId; +@end + + // ---------------------------------------------------------------------------- // // GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1EncryptionSpec @@ -4295,7 +4335,17 @@ @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAn @implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue @dynamic boolValue, key, naValue, normalizedScore, numValue, potentialScore, - score, skipValue, strValue; + rationale, score, skipValue, strValue; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale +// + +@implementation GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale +@dynamic rationale; @end @@ -5116,11 +5166,12 @@ @implementation GTLRContactcenterinsights_GoogleIamV1TestIamPermissionsResponse // @implementation GTLRContactcenterinsights_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRContactcenterinsights_GoogleLongrunningOperation class] + @"operations" : [GTLRContactcenterinsights_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsQuery.m b/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsQuery.m index 62528bdf2..28efdc13f 100644 --- a/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsQuery.m +++ b/Sources/GeneratedServices/Contactcenterinsights/GTLRContactcenterinsightsQuery.m @@ -955,7 +955,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRContactcenterinsightsQuery_ProjectsLocationsAuthorizedViewSetsAuthorizedViewsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -3160,7 +3160,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRContactcenterinsightsQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsObjects.h b/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsObjects.h index fa165ccc5..b147223bc 100644 --- a/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsObjects.h +++ b/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsObjects.h @@ -61,6 +61,7 @@ @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata; +@class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Entity; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Entity_Metadata; @@ -98,6 +99,7 @@ @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswer; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerSource; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue; +@class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaScorecardResult; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaScorecardResultQaTagResult; @@ -189,6 +191,7 @@ @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata; +@class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1EncryptionSpec; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Entity; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Entity_Metadata; @@ -235,6 +238,7 @@ @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswer; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue; +@class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaQuestion; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaQuestionAnswerChoice; @class GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaQuestionMetrics; @@ -471,12 +475,24 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContact * Value: "AGENT" */ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_Agent; +/** + * The dimension is keyed by the agent deployment ID. + * + * Value: "AGENT_DEPLOYMENT_ID" + */ +FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentDeploymentId; /** * The dimension is keyed by agent teams. * * Value: "AGENT_TEAM" */ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentTeam; +/** + * The dimension is keyed by the agent version ID. + * + * Value: "AGENT_VERSION_ID" + */ +FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentVersionId; /** * The dimension is keyed by the conversation profile ID. * @@ -675,6 +691,12 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContact * Value: "EXPORT_V10" */ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV10; +/** + * Export schema version 11. + * + * Value: "EXPORT_V11" + */ +FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV11; /** * Export schema version 2. * @@ -1231,12 +1253,24 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContact * Value: "AGENT" */ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_Agent; +/** + * The dimension is keyed by the agent deployment ID. + * + * Value: "AGENT_DEPLOYMENT_ID" + */ +FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentDeploymentId; /** * The dimension is keyed by agent teams. * * Value: "AGENT_TEAM" */ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentTeam; +/** + * The dimension is keyed by the agent version ID. + * + * Value: "AGENT_VERSION_ID" + */ +FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentVersionId; /** * The dimension is keyed by the conversation profile ID. * @@ -1435,6 +1469,12 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContact * Value: "EXPORT_V10" */ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV10; +/** + * Export schema version 11. + * + * Value: "EXPORT_V11" + */ +FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV11; /** * Export schema version 2. * @@ -3004,6 +3044,14 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo */ @property(nonatomic, copy, nullable) NSString *agentType; +/** + * The agent's deployment display name. Only applicable to automated agents. + */ +@property(nonatomic, copy, nullable) NSString *deploymentDisplayName; + +/** The agent's deployment ID. Only applicable to automated agents. */ +@property(nonatomic, copy, nullable) NSString *deploymentId; + /** The agent's name. */ @property(nonatomic, copy, nullable) NSString *displayName; @@ -3025,6 +3073,12 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo /** User-specified strings representing the agent's teams. */ @property(nonatomic, strong, nullable) NSArray *teams; +/** The agent's version display name. Only applicable to automated agents. */ +@property(nonatomic, copy, nullable) NSString *versionDisplayName; + +/** The agent's version ID. Only applicable to automated agents. */ +@property(nonatomic, copy, nullable) NSString *versionId; + @end @@ -3504,8 +3558,14 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo * Likely values: * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_Agent * The dimension is keyed by agents. (Value: "AGENT") + * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentDeploymentId + * The dimension is keyed by the agent deployment ID. (Value: + * "AGENT_DEPLOYMENT_ID") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentTeam * The dimension is keyed by agent teams. (Value: "AGENT_TEAM") + * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_AgentVersionId + * The dimension is keyed by the agent version ID. (Value: + * "AGENT_VERSION_ID") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1Dimension_DimensionKey_ConversationProfileId * The dimension is keyed by the conversation profile ID. (Value: * "CONVERSATION_PROFILE_ID") @@ -3547,6 +3607,9 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo /** Output only. Metadata about the QA question dimension. */ @property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata *qaQuestionDimensionMetadata; +/** Output only. Metadata about the QA scorecard dimension. */ +@property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata *qaScorecardDimensionMetadata; + @end @@ -3555,15 +3618,47 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo */ @interface GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata : GTLRObject -/** Optional. The agent's name */ +/** + * Optional. The agent's deployment display name. Only applicable to automated + * agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentDeploymentDisplayName; + +/** + * Optional. The agent's deployment ID. Only applicable to automated agents. + * This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentDeploymentId; + +/** + * Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, + * AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ @property(nonatomic, copy, nullable) NSString *agentDisplayName; -/** Optional. A user-specified string representing the agent. */ +/** + * Optional. A user-specified string representing the agent. This will be + * populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID + * dimensions. + */ @property(nonatomic, copy, nullable) NSString *agentId; /** Optional. A user-specified string representing the agent's team. */ @property(nonatomic, copy, nullable) NSString *agentTeam; +/** + * Optional. The agent's version display name. Only applicable to automated + * agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID + * dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentVersionDisplayName; + +/** + * Optional. The agent's version ID. Only applicable to automated agents. This + * will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentVersionId; + @end @@ -3622,6 +3717,17 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo @end +/** + * Metadata about the QA scorecard dimension. + */ +@interface GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata : GTLRObject + +/** Optional. The QA scorecard ID. */ +@property(nonatomic, copy, nullable) NSString *qaScorecardId; + +@end + + /** * A customer-managed encryption key specification that can be applied to all * created resources (e.g. `Conversation`). @@ -3831,6 +3937,8 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo * Export schema version 1. (Value: "EXPORT_V1") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV10 * Export schema version 10. (Value: "EXPORT_V10") + * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV11 + * Export schema version 11. (Value: "EXPORT_V11") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV2 * Export schema version 2. (Value: "EXPORT_V2") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest_ExportSchemaVersion_ExportV3 @@ -4922,6 +5030,13 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo */ @property(nonatomic, strong, nullable) NSNumber *potentialScore; +/** + * Output only. The rationale for the answer. This field is only populated for + * answers that are generated by the LLM. Manual edits currently do not have + * rationales. + */ +@property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale *rationale; + /** * Output only. Numerical score of the answer. * @@ -4944,6 +5059,17 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo @end +/** + * Wrapper for the rationale for the answer. + */ +@interface GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale : GTLRObject + +/** The rationale string for the answer. */ +@property(nonatomic, copy, nullable) NSString *rationale; + +@end + + /** * A tag is a resource which aims to categorize a set of questions across * multiple scorecards, e.g., "Customer Satisfaction","Billing", etc. @@ -5150,10 +5276,10 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo @property(nonatomic, copy, nullable) NSString *location; /** - * The macro average slice contains aggregated averages across the selected - * dimension. i.e. if group_by agent is specified this field will contain the - * average across all agents. This field is only populated if the request - * specifies a Dimension. + * The macro average slice contains aggregated averages across all selected + * dimensions. i.e. if group_by agent and scorecard_id is specified, this field + * will contain the average across all agents and all scorecards. This field is + * only populated if the request specifies a Dimension. */ @property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice *macroAverageSlice; @@ -5248,7 +5374,11 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsights_GoogleIamV1AuditLo @property(nonatomic, strong, nullable) GTLRDuration *averageDuration; /** - * Average QA normalized score. Will exclude 0's in average calculation. + * The average normalized QA score for a scorecard. When computing the average + * across a set of conversations, if a conversation has been evaluated with + * multiple revisions of a scorecard, only the latest revision results will be + * used. Will exclude 0's in average calculation. Will be only populated if the + * request specifies a dimension of QA_SCORECARD_ID. * * Uses NSNumber of doubleValue. */ @@ -7463,6 +7593,14 @@ GTLR_DEPRECATED */ @property(nonatomic, copy, nullable) NSString *agentType; +/** + * The agent's deployment display name. Only applicable to automated agents. + */ +@property(nonatomic, copy, nullable) NSString *deploymentDisplayName; + +/** The agent's deployment ID. Only applicable to automated agents. */ +@property(nonatomic, copy, nullable) NSString *deploymentId; + /** The agent's name. */ @property(nonatomic, copy, nullable) NSString *displayName; @@ -7484,6 +7622,12 @@ GTLR_DEPRECATED /** User-specified strings representing the agent's teams. */ @property(nonatomic, strong, nullable) NSArray *teams; +/** The agent's version display name. Only applicable to automated agents. */ +@property(nonatomic, copy, nullable) NSString *versionDisplayName; + +/** The agent's version ID. Only applicable to automated agents. */ +@property(nonatomic, copy, nullable) NSString *versionId; + @end @@ -7970,8 +8114,14 @@ GTLR_DEPRECATED * Likely values: * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_Agent * The dimension is keyed by agents. (Value: "AGENT") + * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentDeploymentId + * The dimension is keyed by the agent deployment ID. (Value: + * "AGENT_DEPLOYMENT_ID") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentTeam * The dimension is keyed by agent teams. (Value: "AGENT_TEAM") + * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_AgentVersionId + * The dimension is keyed by the agent version ID. (Value: + * "AGENT_VERSION_ID") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1Dimension_DimensionKey_ConversationProfileId * The dimension is keyed by the conversation profile ID. (Value: * "CONVERSATION_PROFILE_ID") @@ -8013,6 +8163,9 @@ GTLR_DEPRECATED /** Output only. Metadata about the QA question dimension. */ @property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata *qaQuestionDimensionMetadata; +/** Output only. Metadata about the QA scorecard dimension. */ +@property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata *qaScorecardDimensionMetadata; + @end @@ -8021,15 +8174,47 @@ GTLR_DEPRECATED */ @interface GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata : GTLRObject -/** Optional. The agent's name */ +/** + * Optional. The agent's deployment display name. Only applicable to automated + * agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentDeploymentDisplayName; + +/** + * Optional. The agent's deployment ID. Only applicable to automated agents. + * This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentDeploymentId; + +/** + * Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, + * AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ @property(nonatomic, copy, nullable) NSString *agentDisplayName; -/** Optional. A user-specified string representing the agent. */ +/** + * Optional. A user-specified string representing the agent. This will be + * populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID + * dimensions. + */ @property(nonatomic, copy, nullable) NSString *agentId; /** Optional. A user-specified string representing the agent's team. */ @property(nonatomic, copy, nullable) NSString *agentTeam; +/** + * Optional. The agent's version display name. Only applicable to automated + * agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID + * dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentVersionDisplayName; + +/** + * Optional. The agent's version ID. Only applicable to automated agents. This + * will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + */ +@property(nonatomic, copy, nullable) NSString *agentVersionId; + @end @@ -8088,6 +8273,17 @@ GTLR_DEPRECATED @end +/** + * Metadata about the QA scorecard dimension. + */ +@interface GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata : GTLRObject + +/** Optional. The QA scorecard ID. */ +@property(nonatomic, copy, nullable) NSString *qaScorecardId; + +@end + + /** * A customer-managed encryption key specification that can be applied to all * created resources (e.g. `Conversation`). @@ -8312,6 +8508,8 @@ GTLR_DEPRECATED * Export schema version 1. (Value: "EXPORT_V1") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV10 * Export schema version 10. (Value: "EXPORT_V10") + * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV11 + * Export schema version 11. (Value: "EXPORT_V11") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV2 * Export schema version 2. (Value: "EXPORT_V2") * @arg @c kGTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest_ExportSchemaVersion_ExportV3 @@ -10074,6 +10272,13 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) NSNumber *potentialScore; +/** + * Output only. The rationale for the answer. This field is only populated for + * answers that are generated by the LLM. Manual edits currently do not have + * rationales. + */ +@property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale *rationale; + /** * Output only. Numerical score of the answer. * @@ -10096,6 +10301,17 @@ GTLR_DEPRECATED @end +/** + * Wrapper for the rationale for the answer. + */ +@interface GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale : GTLRObject + +/** The rationale string for the answer. */ +@property(nonatomic, copy, nullable) NSString *rationale; + +@end + + /** * A single question to be scored by the Insights QA feature. */ @@ -10713,10 +10929,10 @@ GTLR_DEPRECATED @property(nonatomic, copy, nullable) NSString *location; /** - * The macro average slice contains aggregated averages across the selected - * dimension. i.e. if group_by agent is specified this field will contain the - * average across all agents. This field is only populated if the request - * specifies a Dimension. + * The macro average slice contains aggregated averages across all selected + * dimensions. i.e. if group_by agent and scorecard_id is specified, this field + * will contain the average across all agents and all scorecards. This field is + * only populated if the request specifies a Dimension. */ @property(nonatomic, strong, nullable) GTLRContactcenterinsights_GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice *macroAverageSlice; @@ -10811,7 +11027,11 @@ GTLR_DEPRECATED @property(nonatomic, strong, nullable) GTLRDuration *averageDuration; /** - * Average QA normalized score. Will exclude 0's in average calculation. + * The average normalized QA score for a scorecard. When computing the average + * across a set of conversations, if a conversation has been evaluated with + * multiple revisions of a scorecard, only the latest revision results will be + * used. Will exclude 0's in average calculation. Will be only populated if the + * request specifies a dimension of QA_SCORECARD_ID. * * Uses NSNumber of doubleValue. */ @@ -12017,6 +12237,13 @@ GTLR_DEPRECATED */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsQuery.h b/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsQuery.h index d70743513..5e84d4e98 100644 --- a/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsQuery.h +++ b/Sources/GeneratedServices/Contactcenterinsights/Public/GoogleAPIClientForREST/GTLRContactcenterinsightsQuery.h @@ -1681,6 +1681,17 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsightsViewFull; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c * GTLRContactcenterinsights_GoogleLongrunningListOperationsResponse. @@ -5161,6 +5172,17 @@ FOUNDATION_EXTERN NSString * const kGTLRContactcenterinsightsViewFull; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c * GTLRContactcenterinsights_GoogleLongrunningListOperationsResponse. diff --git a/Sources/GeneratedServices/Container/GTLRContainerObjects.m b/Sources/GeneratedServices/Container/GTLRContainerObjects.m index d46a6f141..2e51d73ae 100644 --- a/Sources/GeneratedServices/Container/GTLRContainerObjects.m +++ b/Sources/GeneratedServices/Container/GTLRContainerObjects.m @@ -526,6 +526,10 @@ NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_GkeMetadata = @"GKE_METADATA"; NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_ModeUnspecified = @"MODE_UNSPECIFIED"; +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" +#pragma clang diagnostic ignored "-Wdeprecated-implementations" + // ---------------------------------------------------------------------------- // // GTLRContainer_AcceleratorConfig @@ -733,6 +737,16 @@ @implementation GTLRContainer_AutoprovisioningNodePoolDefaults @end +// ---------------------------------------------------------------------------- +// +// GTLRContainer_AutoscaledRolloutPolicy +// + +@implementation GTLRContainer_AutoscaledRolloutPolicy +@dynamic waitForDrainDuration; +@end + + // ---------------------------------------------------------------------------- // // GTLRContainer_AutoUpgradeOptions @@ -804,7 +818,7 @@ @implementation GTLRContainer_BlueGreenInfo // @implementation GTLRContainer_BlueGreenSettings -@dynamic nodePoolSoakDuration, standardRolloutPolicy; +@dynamic autoscaledRolloutPolicy, nodePoolSoakDuration, standardRolloutPolicy; @end @@ -1323,7 +1337,8 @@ @implementation GTLRContainer_DNSConfig // @implementation GTLRContainer_DNSEndpointConfig -@dynamic allowExternalTraffic, endpoint; +@dynamic allowExternalTraffic, enableK8sCertsViaDns, enableK8sTokensViaDns, + endpoint; @end @@ -3527,3 +3542,5 @@ @implementation GTLRContainer_WorkloadMetadataConfig @implementation GTLRContainer_WorkloadPolicyConfig @dynamic allowNetAdmin, autopilotCompatibilityAuditingEnabled; @end + +#pragma clang diagnostic pop diff --git a/Sources/GeneratedServices/Container/Public/GoogleAPIClientForREST/GTLRContainerObjects.h b/Sources/GeneratedServices/Container/Public/GoogleAPIClientForREST/GTLRContainerObjects.h index 76f0f9bf7..eab8d1778 100644 --- a/Sources/GeneratedServices/Container/Public/GoogleAPIClientForREST/GTLRContainerObjects.h +++ b/Sources/GeneratedServices/Container/Public/GoogleAPIClientForREST/GTLRContainerObjects.h @@ -31,6 +31,7 @@ @class GTLRContainer_AutopilotCompatibilityIssue; @class GTLRContainer_AutopilotConfig; @class GTLRContainer_AutoprovisioningNodePoolDefaults; +@class GTLRContainer_AutoscaledRolloutPolicy; @class GTLRContainer_AutoUpgradeOptions; @class GTLRContainer_BestEffortProvisioning; @class GTLRContainer_BigQueryDestination; @@ -206,6 +207,7 @@ // causing warnings since clang's checks are some what arbitrary. #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdocumentation" +#pragma clang diagnostic ignored "-Wdeprecated-declarations" NS_ASSUME_NONNULL_BEGIN @@ -1176,7 +1178,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_LinuxNodeConfig_TransparentHug /** * It means that an application will wake kswapd in the background to reclaim * pages and wake kcompactd to compact memory so that THP is available in the - * near future. It’s the responsibility of khugepaged to then install the THP + * near future. It's the responsibility of khugepaged to then install the THP * pages later. * * Value: "TRANSPARENT_HUGEPAGE_DEFRAG_DEFER" @@ -2978,7 +2980,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** * Configuration for the ConfigConnector add-on, a Kubernetes extension to - * manage hosted GCP services through the Kubernetes API + * manage hosted Google Cloud services through the Kubernetes API. */ @property(nonatomic, strong, nullable) GTLRContainer_ConfigConnectorConfig *configConnectorConfig; @@ -2988,7 +2990,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** Configuration for the Compute Engine Persistent Disk CSI driver. */ @property(nonatomic, strong, nullable) GTLRContainer_GcePersistentDiskCsiDriverConfig *gcePersistentDiskCsiDriverConfig; -/** Configuration for the GCP Filestore CSI driver. */ +/** Configuration for the Filestore CSI driver. */ @property(nonatomic, strong, nullable) GTLRContainer_GcpFilestoreCsiDriverConfig *gcpFilestoreCsiDriverConfig; /** Configuration for the Cloud Storage Fuse CSI driver. */ @@ -3370,6 +3372,22 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo @end +/** + * Autoscaled rollout policy utilizes the cluster autoscaler during blue-green + * upgrade to scale both the blue and green pools. + */ +@interface GTLRContainer_AutoscaledRolloutPolicy : GTLRObject + +/** + * Optional. Time to wait after cordoning the blue pool before draining the + * nodes. Defaults to 3 days. The value can be set between 0 and 7 days, + * inclusive. + */ +@property(nonatomic, strong, nullable) GTLRDuration *waitForDrainDuration; + +@end + + /** * AutoUpgradeOptions defines the set of options for the user to control how * the Auto Upgrades will proceed. @@ -3523,6 +3541,9 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo */ @interface GTLRContainer_BlueGreenSettings : GTLRObject +/** Autoscaled policy for cluster autoscaler enabled blue-green upgrade. */ +@property(nonatomic, strong, nullable) GTLRContainer_AutoscaledRolloutPolicy *autoscaledRolloutPolicy; + /** * Time needed after draining entire blue pool. After this period, blue pool * will be cleaned up. @@ -3831,8 +3852,11 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo */ @property(nonatomic, copy, nullable) NSString *endpoint; -/** GKE Enterprise Configuration. */ -@property(nonatomic, strong, nullable) GTLRContainer_EnterpriseConfig *enterpriseConfig; +/** + * GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now + * available without an Enterprise tier. + */ +@property(nonatomic, strong, nullable) GTLRContainer_EnterpriseConfig *enterpriseConfig GTLR_DEPRECATED; /** * This checksum is computed by the server based on the value of cluster @@ -4172,8 +4196,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo @property(nonatomic, strong, nullable) GTLRContainer_VerticalPodAutoscaling *verticalPodAutoscaling; /** - * Configuration for the use of Kubernetes Service Accounts in GCP IAM - * policies. + * Configuration for the use of Kubernetes Service Accounts in IAM policies. */ @property(nonatomic, strong, nullable) GTLRContainer_WorkloadIdentityConfig *workloadIdentityConfig; @@ -4401,8 +4424,11 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo */ @property(nonatomic, strong, nullable) NSNumber *desiredEnablePrivateEndpoint GTLR_DEPRECATED; -/** The desired enterprise configuration for the cluster. */ -@property(nonatomic, strong, nullable) GTLRContainer_DesiredEnterpriseConfig *desiredEnterpriseConfig; +/** + * The desired enterprise configuration for the cluster. Deprecated: GKE + * Enterprise features are now available without an Enterprise tier. + */ +@property(nonatomic, strong, nullable) GTLRContainer_DesiredEnterpriseConfig *desiredEnterpriseConfig GTLR_DEPRECATED; /** The desired fleet configuration for the cluster. */ @property(nonatomic, strong, nullable) GTLRContainer_Fleet *desiredFleet; @@ -5130,7 +5156,10 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** * DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. + * Deprecated: GKE Enterprise features are now available without an Enterprise + * tier. */ +GTLR_DEPRECATED @interface GTLRContainer_DesiredEnterpriseConfig : GTLRObject /** @@ -5216,12 +5245,26 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** * Controls whether user traffic is allowed over this endpoint. Note that - * GCP-managed services may still use the endpoint even if this is false. + * Google-managed services may still use the endpoint even if this is false. * * Uses NSNumber of boolValue. */ @property(nonatomic, strong, nullable) NSNumber *allowExternalTraffic; +/** + * Controls whether the k8s certs auth is allowed via DNS. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableK8sCertsViaDns; + +/** + * Controls whether the k8s token auth is allowed via DNS. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableK8sTokensViaDns; + /** * Output only. The cluster's DNS endpoint configuration. A DNS format address. * This is accessible from the public internet. Ex: uid.us-central1.gke.goog. @@ -5244,8 +5287,10 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** - * EnterpriseConfig is the cluster enterprise configuration. + * EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE + * Enterprise features are now available without an Enterprise tier. */ +GTLR_DEPRECATED @interface GTLRContainer_EnterpriseConfig : GTLRObject /** @@ -5615,12 +5660,12 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** - * Configuration for the GCP Filestore CSI driver. + * Configuration for the Filestore CSI driver. */ @interface GTLRContainer_GcpFilestoreCsiDriverConfig : GTLRObject /** - * Whether the GCP Filestore CSI driver is enabled for this cluster. + * Whether the Filestore CSI driver is enabled for this cluster. * * Uses NSNumber of boolValue. */ @@ -6349,7 +6394,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo * @arg @c kGTLRContainer_LinuxNodeConfig_TransparentHugepageDefrag_TransparentHugepageDefragDefer * It means that an application will wake kswapd in the background to * reclaim pages and wake kcompactd to compact memory so that THP is - * available in the near future. It’s the responsibility of khugepaged to + * available in the near future. It's the responsibility of khugepaged to * then install the THP pages later. (Value: * "TRANSPARENT_HUGEPAGE_DEFRAG_DEFER") * @arg @c kGTLRContainer_LinuxNodeConfig_TransparentHugepageDefrag_TransparentHugepageDefragDeferWithMadvise @@ -9126,7 +9171,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** - * Collection of [GCP + * Collection of [Resource Manager * labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). */ @interface GTLRContainer_ResourceLabels : GTLRObject @@ -11309,8 +11354,7 @@ FOUNDATION_EXTERN NSString * const kGTLRContainer_WorkloadMetadataConfig_Mode_Mo /** - * Configuration for the use of Kubernetes Service Accounts in GCP IAM - * policies. + * Configuration for the use of Kubernetes Service Accounts in IAM policies. */ @interface GTLRContainer_WorkloadIdentityConfig : GTLRObject diff --git a/Sources/GeneratedServices/DLP/GTLRDLPObjects.m b/Sources/GeneratedServices/DLP/GTLRDLPObjects.m index 469a1aa8b..3214e1235 100644 --- a/Sources/GeneratedServices/DLP/GTLRDLPObjects.m +++ b/Sources/GeneratedServices/DLP/GTLRDLPObjects.m @@ -649,7 +649,8 @@ @implementation GTLRDLP_GooglePrivacyDlpV2Action @dynamic deidentify, jobNotificationEmails, publishFindingsToCloudDataCatalog, - publishSummaryToCscc, publishToStackdriver, pubSub, saveFindings; + publishFindingsToDataplexCatalog, publishSummaryToCscc, + publishToStackdriver, pubSub, saveFindings; @end @@ -2342,7 +2343,7 @@ @implementation GTLRDLP_GooglePrivacyDlpV2FileSet // @implementation GTLRDLP_GooglePrivacyDlpV2FileStoreCollection -@dynamic includeRegexes; +@dynamic includeRegexes, includeTags; @end @@ -3741,7 +3742,7 @@ @implementation GTLRDLP_GooglePrivacyDlpV2OtherInfoTypeSummary // @implementation GTLRDLP_GooglePrivacyDlpV2OutputStorageConfig -@dynamic outputSchema, table; +@dynamic outputSchema, storagePath, table; @end @@ -3851,6 +3852,15 @@ @implementation GTLRDLP_GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog @end +// ---------------------------------------------------------------------------- +// +// GTLRDLP_GooglePrivacyDlpV2PublishFindingsToDataplexCatalog +// + +@implementation GTLRDLP_GooglePrivacyDlpV2PublishFindingsToDataplexCatalog +@end + + // ---------------------------------------------------------------------------- // // GTLRDLP_GooglePrivacyDlpV2PublishSummaryToCscc @@ -4648,6 +4658,34 @@ @implementation GTLRDLP_GooglePrivacyDlpV2TagCondition @end +// ---------------------------------------------------------------------------- +// +// GTLRDLP_GooglePrivacyDlpV2TagFilter +// + +@implementation GTLRDLP_GooglePrivacyDlpV2TagFilter +@dynamic namespacedTagKey, namespacedTagValue; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDLP_GooglePrivacyDlpV2TagFilters +// + +@implementation GTLRDLP_GooglePrivacyDlpV2TagFilters +@dynamic tagFilters; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"tagFilters" : [GTLRDLP_GooglePrivacyDlpV2TagFilter class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDLP_GooglePrivacyDlpV2TaggedField diff --git a/Sources/GeneratedServices/DLP/Public/GoogleAPIClientForREST/GTLRDLPObjects.h b/Sources/GeneratedServices/DLP/Public/GoogleAPIClientForREST/GTLRDLPObjects.h index 14e222733..2642a71f7 100644 --- a/Sources/GeneratedServices/DLP/Public/GoogleAPIClientForREST/GTLRDLPObjects.h +++ b/Sources/GeneratedServices/DLP/Public/GoogleAPIClientForREST/GTLRDLPObjects.h @@ -227,6 +227,7 @@ @class GTLRDLP_GooglePrivacyDlpV2ProjectDataProfile; @class GTLRDLP_GooglePrivacyDlpV2Proximity; @class GTLRDLP_GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog; +@class GTLRDLP_GooglePrivacyDlpV2PublishFindingsToDataplexCatalog; @class GTLRDLP_GooglePrivacyDlpV2PublishSummaryToCscc; @class GTLRDLP_GooglePrivacyDlpV2PublishToChronicle; @class GTLRDLP_GooglePrivacyDlpV2PublishToDataplexCatalog; @@ -284,6 +285,8 @@ @class GTLRDLP_GooglePrivacyDlpV2TableReference; @class GTLRDLP_GooglePrivacyDlpV2Tag; @class GTLRDLP_GooglePrivacyDlpV2TagCondition; +@class GTLRDLP_GooglePrivacyDlpV2TagFilter; +@class GTLRDLP_GooglePrivacyDlpV2TagFilters; @class GTLRDLP_GooglePrivacyDlpV2TaggedField; @class GTLRDLP_GooglePrivacyDlpV2TagResources; @class GTLRDLP_GooglePrivacyDlpV2TagValue; @@ -3559,6 +3562,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDLP_GooglePrivacyDlpV2Value_DayOfWeekVal /** Publish findings to Cloud Datahub. */ @property(nonatomic, strong, nullable) GTLRDLP_GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog *publishFindingsToCloudDataCatalog; +/** Publish findings as an aspect to Dataplex Universal Catalog. */ +@property(nonatomic, strong, nullable) GTLRDLP_GooglePrivacyDlpV2PublishFindingsToDataplexCatalog *publishFindingsToDataplexCatalog; + /** Publish summary to Cloud Security Command Center (Alpha). */ @property(nonatomic, strong, nullable) GTLRDLP_GooglePrivacyDlpV2PublishSummaryToCscc *publishSummaryToCscc; @@ -7733,6 +7739,18 @@ FOUNDATION_EXTERN NSString * const kGTLRDLP_GooglePrivacyDlpV2Value_DayOfWeekVal */ @property(nonatomic, strong, nullable) GTLRDLP_GooglePrivacyDlpV2FileStoreRegexes *includeRegexes; +/** + * Optional. To be included in the collection, a resource must meet all of the + * following requirements: - If tag filters are provided, match all provided + * tag filters. - If one or more patterns are specified, match at least one + * pattern. For a resource to match the tag filters, the resource must have all + * of the provided tags attached. Tags refer to Resource Manager tags bound to + * the resource or its ancestors. See + * https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules + * to learn more. + */ +@property(nonatomic, strong, nullable) GTLRDLP_GooglePrivacyDlpV2TagFilters *includeTags; + @end @@ -10370,6 +10388,17 @@ FOUNDATION_EXTERN NSString * const kGTLRDLP_GooglePrivacyDlpV2Value_DayOfWeekVal */ @property(nonatomic, copy, nullable) NSString *outputSchema; +/** + * Store findings in an existing Cloud Storage bucket. Files will be generated + * with the job ID and file part number as the filename, and will contain + * findings in textproto format as SaveToGcsFindingsOutput. The file name will + * use the naming convention -, for example: my-job-id-2. Supported for Inspect + * jobs. The bucket must not be the same as the bucket being inspected. If + * storing findings to Cloud Storage, the output schema field should not be + * set. If set, it will be ignored. + */ +@property(nonatomic, strong, nullable) GTLRDLP_GooglePrivacyDlpV2CloudStoragePath *storagePath; + /** * Store findings in an existing table or a new table in an existing dataset. * If table_id is not set a new one will be generated for you with the @@ -10632,6 +10661,22 @@ FOUNDATION_EXTERN NSString * const kGTLRDLP_GooglePrivacyDlpV2Value_DayOfWeekVal @end +/** + * Publish findings of a DlpJob to Dataplex Universal Catalog as a + * `sensitive-data-protection-job-result` aspect. To learn more about aspects, + * see [Send inspection results to Dataplex Universal Catalog as + * aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). + * Aspects are persisted in Dataplex Universal Catalog storage and are governed + * by service-specific policies for Dataplex Universal Catalog. For more + * information, see [Service Specific + * Terms](https://cloud.google.com/terms/service-terms). Only a single instance + * of this action can be specified. This action is allowed only if all + * resources being scanned are BigQuery tables. Compatible with: Inspect + */ +@interface GTLRDLP_GooglePrivacyDlpV2PublishFindingsToDataplexCatalog : GTLRObject +@end + + /** * Publish the result summary of a DlpJob to [Security Command * Center](https://cloud.google.com/security-command-center). This action is @@ -12081,6 +12126,43 @@ FOUNDATION_EXTERN NSString * const kGTLRDLP_GooglePrivacyDlpV2Value_DayOfWeekVal @end +/** + * A single tag to filter against. + */ +@interface GTLRDLP_GooglePrivacyDlpV2TagFilter : GTLRObject + +/** + * The namespaced name for the tag key. Must be in the format + * `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an + * organization parent, or "my-project/sensitive" for a project parent. + */ +@property(nonatomic, copy, nullable) NSString *namespacedTagKey; + +/** + * The namespaced name for the tag value. Must be in the format + * `{parent_id}/{tag_key_short_name}/{short_name}`, for example, + * "123456/environment/prod" for an organization parent, or + * "my-project/environment/prod" for a project parent. + */ +@property(nonatomic, copy, nullable) NSString *namespacedTagValue; + +@end + + +/** + * Tags to match against for filtering. + */ +@interface GTLRDLP_GooglePrivacyDlpV2TagFilters : GTLRObject + +/** + * Required. A resource must match ALL of the specified tag filters to be + * included in the collection. + */ +@property(nonatomic, strong, nullable) NSArray *tagFilters; + +@end + + /** * A column with a semantic tag attached. */ diff --git a/Sources/GeneratedServices/Dataform/GTLRDataformObjects.m b/Sources/GeneratedServices/Dataform/GTLRDataformObjects.m index 6f00f46cd..61253b1d4 100644 --- a/Sources/GeneratedServices/Dataform/GTLRDataformObjects.m +++ b/Sources/GeneratedServices/Dataform/GTLRDataformObjects.m @@ -136,24 +136,6 @@ @implementation GTLRDataform_BigQueryAction @end -// ---------------------------------------------------------------------------- -// -// GTLRDataform_Binding -// - -@implementation GTLRDataform_Binding -@dynamic condition, members, role; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"members" : [NSString class] - }; - return map; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRDataform_CancelOperationRequest @@ -479,21 +461,6 @@ @implementation GTLRDataform_ErrorTable @end -// ---------------------------------------------------------------------------- -// -// GTLRDataform_Expr -// - -@implementation GTLRDataform_Expr -@dynamic descriptionProperty, expression, location, title; - -+ (NSDictionary *)propertyToJSONKeyMap { - return @{ @"descriptionProperty" : @"description" }; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRDataform_FetchFileDiffResponse @@ -1090,28 +1057,6 @@ @implementation GTLRDataform_Operations @end -// ---------------------------------------------------------------------------- -// -// GTLRDataform_Policy -// - -@implementation GTLRDataform_Policy -@dynamic bindings, ETag, version; - -+ (NSDictionary *)propertyToJSONKeyMap { - return @{ @"ETag" : @"etag" }; -} - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"bindings" : [GTLRDataform_Binding class] - }; - return map; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRDataform_PolicyName @@ -1512,16 +1457,6 @@ @implementation GTLRDataform_SearchResult @end -// ---------------------------------------------------------------------------- -// -// GTLRDataform_SetIamPolicyRequest -// - -@implementation GTLRDataform_SetIamPolicyRequest -@dynamic policy; -@end - - // ---------------------------------------------------------------------------- // // GTLRDataform_SimpleLoadMode @@ -1593,42 +1528,6 @@ @implementation GTLRDataform_Target @end -// ---------------------------------------------------------------------------- -// -// GTLRDataform_TestIamPermissionsRequest -// - -@implementation GTLRDataform_TestIamPermissionsRequest -@dynamic permissions; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"permissions" : [NSString class] - }; - return map; -} - -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRDataform_TestIamPermissionsResponse -// - -@implementation GTLRDataform_TestIamPermissionsResponse -@dynamic permissions; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"permissions" : [NSString class] - }; - return map; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRDataform_UncommittedFileChange diff --git a/Sources/GeneratedServices/Dataform/GTLRDataformQuery.m b/Sources/GeneratedServices/Dataform/GTLRDataformQuery.m index fe1fd5233..10a9269cf 100644 --- a/Sources/GeneratedServices/Dataform/GTLRDataformQuery.m +++ b/Sources/GeneratedServices/Dataform/GTLRDataformQuery.m @@ -17,83 +17,6 @@ @implementation GTLRDataformQuery @end -@implementation GTLRDataformQuery_ProjectsLocationsFoldersGetIamPolicy - -@dynamic optionsRequestedPolicyVersion, resource; - -+ (NSDictionary *)parameterNameMap { - return @{ @"optionsRequestedPolicyVersion" : @"options.requestedPolicyVersion" }; -} - -+ (instancetype)queryWithResource:(NSString *)resource { - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:getIamPolicy"; - GTLRDataformQuery_ProjectsLocationsFoldersGetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.folders.getIamPolicy"; - return query; -} - -@end - -@implementation GTLRDataformQuery_ProjectsLocationsFoldersSetIamPolicy - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:setIamPolicy"; - GTLRDataformQuery_ProjectsLocationsFoldersSetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.folders.setIamPolicy"; - return query; -} - -@end - -@implementation GTLRDataformQuery_ProjectsLocationsFoldersTestIamPermissions - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:testIamPermissions"; - GTLRDataformQuery_ProjectsLocationsFoldersTestIamPermissions *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_TestIamPermissionsResponse class]; - query.loggingName = @"dataform.projects.locations.folders.testIamPermissions"; - return query; -} - -@end - @implementation GTLRDataformQuery_ProjectsLocationsGet @dynamic name; @@ -475,29 +398,6 @@ + (instancetype)queryWithName:(NSString *)name { @end -@implementation GTLRDataformQuery_ProjectsLocationsRepositoriesGetIamPolicy - -@dynamic optionsRequestedPolicyVersion, resource; - -+ (NSDictionary *)parameterNameMap { - return @{ @"optionsRequestedPolicyVersion" : @"options.requestedPolicyVersion" }; -} - -+ (instancetype)queryWithResource:(NSString *)resource { - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:getIamPolicy"; - GTLRDataformQuery_ProjectsLocationsRepositoriesGetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.repositories.getIamPolicy"; - return query; -} - -@end - @implementation GTLRDataformQuery_ProjectsLocationsRepositoriesList @dynamic filter, orderBy, pageSize, pageToken, parent; @@ -693,60 +593,6 @@ + (instancetype)queryWithObject:(GTLRDataform_ReleaseConfig *)object @end -@implementation GTLRDataformQuery_ProjectsLocationsRepositoriesSetIamPolicy - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:setIamPolicy"; - GTLRDataformQuery_ProjectsLocationsRepositoriesSetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.repositories.setIamPolicy"; - return query; -} - -@end - -@implementation GTLRDataformQuery_ProjectsLocationsRepositoriesTestIamPermissions - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:testIamPermissions"; - GTLRDataformQuery_ProjectsLocationsRepositoriesTestIamPermissions *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_TestIamPermissionsResponse class]; - query.loggingName = @"dataform.projects.locations.repositories.testIamPermissions"; - return query; -} - -@end - @implementation GTLRDataformQuery_ProjectsLocationsRepositoriesWorkflowConfigsCreate @dynamic parent, workflowConfigId; @@ -1137,29 +983,6 @@ + (instancetype)queryWithName:(NSString *)name { @end -@implementation GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesGetIamPolicy - -@dynamic optionsRequestedPolicyVersion, resource; - -+ (NSDictionary *)parameterNameMap { - return @{ @"optionsRequestedPolicyVersion" : @"options.requestedPolicyVersion" }; -} - -+ (instancetype)queryWithResource:(NSString *)resource { - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:getIamPolicy"; - GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesGetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.repositories.workspaces.getIamPolicy"; - return query; -} - -@end - @implementation GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesInstallNpmPackages @dynamic workspace; @@ -1479,60 +1302,6 @@ + (instancetype)queryWithWorkspace:(NSString *)workspace { @end -@implementation GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesSetIamPolicy - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:setIamPolicy"; - GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesSetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.repositories.workspaces.setIamPolicy"; - return query; -} - -@end - -@implementation GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesTestIamPermissions - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:testIamPermissions"; - GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesTestIamPermissions *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_TestIamPermissionsResponse class]; - query.loggingName = @"dataform.projects.locations.repositories.workspaces.testIamPermissions"; - return query; -} - -@end - @implementation GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesWriteFile @dynamic workspace; @@ -1560,83 +1329,6 @@ + (instancetype)queryWithObject:(GTLRDataform_WriteFileRequest *)object @end -@implementation GTLRDataformQuery_ProjectsLocationsTeamFoldersGetIamPolicy - -@dynamic optionsRequestedPolicyVersion, resource; - -+ (NSDictionary *)parameterNameMap { - return @{ @"optionsRequestedPolicyVersion" : @"options.requestedPolicyVersion" }; -} - -+ (instancetype)queryWithResource:(NSString *)resource { - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:getIamPolicy"; - GTLRDataformQuery_ProjectsLocationsTeamFoldersGetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.teamFolders.getIamPolicy"; - return query; -} - -@end - -@implementation GTLRDataformQuery_ProjectsLocationsTeamFoldersSetIamPolicy - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:setIamPolicy"; - GTLRDataformQuery_ProjectsLocationsTeamFoldersSetIamPolicy *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_Policy class]; - query.loggingName = @"dataform.projects.locations.teamFolders.setIamPolicy"; - return query; -} - -@end - -@implementation GTLRDataformQuery_ProjectsLocationsTeamFoldersTestIamPermissions - -@dynamic resource; - -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"resource" ]; - NSString *pathURITemplate = @"v1beta1/{+resource}:testIamPermissions"; - GTLRDataformQuery_ProjectsLocationsTeamFoldersTestIamPermissions *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.resource = resource; - query.expectedObjectClass = [GTLRDataform_TestIamPermissionsResponse class]; - query.loggingName = @"dataform.projects.locations.teamFolders.testIamPermissions"; - return query; -} - -@end - @implementation GTLRDataformQuery_ProjectsLocationsUpdateConfig @dynamic name, updateMask; diff --git a/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformObjects.h b/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformObjects.h index 38765e355..c3824e95a 100644 --- a/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformObjects.h +++ b/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformObjects.h @@ -22,7 +22,6 @@ @class GTLRDataform_ActionSqlDefinition; @class GTLRDataform_Assertion; @class GTLRDataform_BigQueryAction; -@class GTLRDataform_Binding; @class GTLRDataform_CodeCompilationConfig; @class GTLRDataform_CodeCompilationConfig_Vars; @class GTLRDataform_ColumnDescriptor; @@ -41,7 +40,6 @@ @class GTLRDataform_DirectoryEntry; @class GTLRDataform_DirectorySearchResult; @class GTLRDataform_ErrorTable; -@class GTLRDataform_Expr; @class GTLRDataform_FileOperation; @class GTLRDataform_FileSearchResult; @class GTLRDataform_GitRemoteSettings; @@ -60,7 +58,6 @@ @class GTLRDataform_Operation_Metadata; @class GTLRDataform_Operation_Response; @class GTLRDataform_Operations; -@class GTLRDataform_Policy; @class GTLRDataform_PolicyName; @class GTLRDataform_Relation; @class GTLRDataform_Relation_AdditionalOptions; @@ -448,92 +445,6 @@ FOUNDATION_EXTERN NSString * const kGTLRDataform_WorkflowInvocationAction_State_ @end -/** - * Associates `members`, or principals, with a `role`. - */ -@interface GTLRDataform_Binding : GTLRObject - -/** - * The condition that is associated with this binding. If the condition - * evaluates to `true`, then this binding applies to the current request. If - * the condition evaluates to `false`, then this binding does not apply to the - * current request. However, a different role binding might grant the same role - * to one or more of the principals in this binding. To learn which resources - * support conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ -@property(nonatomic, strong, nullable) GTLRDataform_Expr *condition; - -/** - * Specifies the principals requesting access for a Google Cloud resource. - * `members` can have the following values: * `allUsers`: A special identifier - * that represents anyone who is on the internet; with or without a Google - * account. * `allAuthenticatedUsers`: A special identifier that represents - * anyone who is authenticated with a Google account or a service account. Does - * not include identities that come from external identity providers (IdPs) - * through identity federation. * `user:{emailid}`: An email address that - * represents a specific Google account. For example, `alice\@example.com` . * - * `serviceAccount:{emailid}`: An email address that represents a Google - * service account. For example, `my-other-app\@appspot.gserviceaccount.com`. * - * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An - * identifier for a [Kubernetes service - * account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - * For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - * `group:{emailid}`: An email address that represents a Google group. For - * example, `admins\@example.com`. * `domain:{domain}`: The G Suite domain - * (primary) that represents all the users of that domain. For example, - * `google.com` or `example.com`. * - * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - * A single identity in a workforce identity pool. * - * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - * All workforce identities in a group. * - * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - * All workforce identities with a specific attribute value. * - * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/ - * *`: All identities in a workforce identity pool. * - * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - * A single identity in a workload identity pool. * - * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - * A workload identity pool group. * - * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - * All identities in a workload identity pool with a certain attribute. * - * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/ - * *`: All identities in a workload identity pool. * - * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique - * identifier) representing a user that has been recently deleted. For example, - * `alice\@example.com?uid=123456789012345678901`. If the user is recovered, - * this value reverts to `user:{emailid}` and the recovered user retains the - * role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An - * email address (plus unique identifier) representing a service account that - * has been recently deleted. For example, - * `my-other-app\@appspot.gserviceaccount.com?uid=123456789012345678901`. If - * the service account is undeleted, this value reverts to - * `serviceAccount:{emailid}` and the undeleted service account retains the - * role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email - * address (plus unique identifier) representing a Google group that has been - * recently deleted. For example, - * `admins\@example.com?uid=123456789012345678901`. If the group is recovered, - * this value reverts to `group:{emailid}` and the recovered group retains the - * role in the binding. * - * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - * Deleted single identity in a workforce identity pool. For example, - * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - */ -@property(nonatomic, strong, nullable) NSArray *members; - -/** - * Role that is assigned to the list of `members`, or principals. For example, - * `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM - * roles and permissions, see the [IAM - * documentation](https://cloud.google.com/iam/docs/roles-overview). For a list - * of the available pre-defined roles, see - * [here](https://cloud.google.com/iam/docs/understanding-roles). - */ -@property(nonatomic, copy, nullable) NSString *role; - -@end - - /** * The request message for Operations.CancelOperation. */ @@ -1099,55 +1010,6 @@ FOUNDATION_EXTERN NSString * const kGTLRDataform_WorkflowInvocationAction_State_ @end -/** - * Represents a textual expression in the Common Expression Language (CEL) - * syntax. CEL is a C-like expression language. The syntax and semantics of CEL - * are documented at https://github.com/google/cel-spec. Example (Comparison): - * title: "Summary size limit" description: "Determines if a summary is less - * than 100 chars" expression: "document.summary.size() < 100" Example - * (Equality): title: "Requestor is owner" description: "Determines if - * requestor is the document owner" expression: "document.owner == - * request.auth.claims.email" Example (Logic): title: "Public documents" - * description: "Determine whether the document should be publicly visible" - * expression: "document.type != 'private' && document.type != 'internal'" - * Example (Data Manipulation): title: "Notification string" description: - * "Create a notification string with a timestamp." expression: "'New message - * received at ' + string(document.create_time)" The exact variables and - * functions that may be referenced within an expression are determined by the - * service that evaluates it. See the service documentation for additional - * information. - */ -@interface GTLRDataform_Expr : GTLRObject - -/** - * Optional. Description of the expression. This is a longer text which - * describes the expression, e.g. when hovered over it in a UI. - * - * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. - */ -@property(nonatomic, copy, nullable) NSString *descriptionProperty; - -/** - * Textual representation of an expression in Common Expression Language - * syntax. - */ -@property(nonatomic, copy, nullable) NSString *expression; - -/** - * Optional. String indicating the location of the expression for error - * reporting, e.g. a file name and a position in the file. - */ -@property(nonatomic, copy, nullable) NSString *location; - -/** - * Optional. Title for the expression, i.e. a short string describing its - * purpose. This can be used e.g. in UIs which allow to enter the expression. - */ -@property(nonatomic, copy, nullable) NSString *title; - -@end - - /** * `FetchFileDiff` response message. */ @@ -2071,94 +1933,6 @@ FOUNDATION_EXTERN NSString * const kGTLRDataform_WorkflowInvocationAction_State_ @end -/** - * An Identity and Access Management (IAM) policy, which specifies access - * controls for Google Cloud resources. A `Policy` is a collection of - * `bindings`. A `binding` binds one or more `members`, or principals, to a - * single `role`. Principals can be user accounts, service accounts, Google - * groups, and domains (such as G Suite). A `role` is a named list of - * permissions; each `role` can be an IAM predefined role or a user-created - * custom role. For some types of Google Cloud resources, a `binding` can also - * specify a `condition`, which is a logical expression that allows access to a - * resource only if the expression evaluates to `true`. A condition can add - * constraints based on attributes of the request, the resource, or both. To - * learn which resources support conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * **JSON example:** ``` { "bindings": [ { "role": - * "roles/resourcemanager.organizationAdmin", "members": [ - * "user:mike\@example.com", "group:admins\@example.com", "domain:google.com", - * "serviceAccount:my-project-id\@appspot.gserviceaccount.com" ] }, { "role": - * "roles/resourcemanager.organizationViewer", "members": [ - * "user:eve\@example.com" ], "condition": { "title": "expirable access", - * "description": "Does not grant access after Sep 2020", "expression": - * "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - * "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - * members: - user:mike\@example.com - group:admins\@example.com - - * domain:google.com - - * serviceAccount:my-project-id\@appspot.gserviceaccount.com role: - * roles/resourcemanager.organizationAdmin - members: - user:eve\@example.com - * role: roles/resourcemanager.organizationViewer condition: title: expirable - * access description: Does not grant access after Sep 2020 expression: - * request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= - * version: 3 ``` For a description of IAM and its features, see the [IAM - * documentation](https://cloud.google.com/iam/docs/). - */ -@interface GTLRDataform_Policy : GTLRObject - -/** - * Associates a list of `members`, or principals, with a `role`. Optionally, - * may specify a `condition` that determines how and when the `bindings` are - * applied. Each of the `bindings` must contain at least one principal. The - * `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of - * these principals can be Google groups. Each occurrence of a principal counts - * towards these limits. For example, if the `bindings` grant 50 different - * roles to `user:alice\@example.com`, and not to any other principal, then you - * can add another 1,450 principals to the `bindings` in the `Policy`. - */ -@property(nonatomic, strong, nullable) NSArray *bindings; - -/** - * `etag` is used for optimistic concurrency control as a way to help prevent - * simultaneous updates of a policy from overwriting each other. It is strongly - * suggested that systems make use of the `etag` in the read-modify-write cycle - * to perform policy updates in order to avoid race conditions: An `etag` is - * returned in the response to `getIamPolicy`, and systems are expected to put - * that etag in the request to `setIamPolicy` to ensure that their change will - * be applied to the same version of the policy. **Important:** If you use IAM - * Conditions, you must include the `etag` field whenever you call - * `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a - * version `3` policy with a version `1` policy, and all of the conditions in - * the version `3` policy are lost. - * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). - */ -@property(nonatomic, copy, nullable) NSString *ETag; - -/** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. - * Requests that specify an invalid value are rejected. Any operation that - * affects conditional role bindings must specify version `3`. This requirement - * applies to the following operations: * Getting a policy that includes a - * conditional role binding * Adding a conditional role binding to a policy * - * Changing a conditional role binding in a policy * Removing any role binding, - * with or without a condition, from a policy that includes conditions - * **Important:** If you use IAM Conditions, you must include the `etag` field - * whenever you call `setIamPolicy`. If you omit this field, then IAM allows - * you to overwrite a version `3` policy with a version `1` policy, and all of - * the conditions in the version `3` policy are lost. If a policy does not - * include any conditions, operations on that policy may specify any valid - * version or leave the field unset. To learn which resources support - * conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * - * Uses NSNumber of intValue. - */ -@property(nonatomic, strong, nullable) NSNumber *version; - -@end - - /** * An internal name for an IAM policy, based on the resource to which the * policy applies. Not to be confused with a resource's external full resource @@ -2836,21 +2610,6 @@ FOUNDATION_EXTERN NSString * const kGTLRDataform_WorkflowInvocationAction_State_ @end -/** - * Request message for `SetIamPolicy` method. - */ -@interface GTLRDataform_SetIamPolicyRequest : GTLRObject - -/** - * REQUIRED: The complete policy to be applied to the `resource`. The size of - * the policy is limited to a few 10s of KB. An empty policy is a valid policy - * but certain Google Cloud services (such as Projects) might reject them. - */ -@property(nonatomic, strong, nullable) GTLRDataform_Policy *policy; - -@end - - /** * Simple load definition */ @@ -2962,34 +2721,6 @@ FOUNDATION_EXTERN NSString * const kGTLRDataform_WorkflowInvocationAction_State_ @end -/** - * Request message for `TestIamPermissions` method. - */ -@interface GTLRDataform_TestIamPermissionsRequest : GTLRObject - -/** - * 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). - */ -@property(nonatomic, strong, nullable) NSArray *permissions; - -@end - - -/** - * Response message for `TestIamPermissions` method. - */ -@interface GTLRDataform_TestIamPermissionsResponse : GTLRObject - -/** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ -@property(nonatomic, strong, nullable) NSArray *permissions; - -@end - - /** * Represents the Git state of a file with uncommitted changes. */ diff --git a/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformQuery.h b/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformQuery.h index 549f3e950..943af8b46 100644 --- a/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformQuery.h +++ b/Sources/GeneratedServices/Dataform/Public/GoogleAPIClientForREST/GTLRDataformQuery.h @@ -34,142 +34,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * Method: dataform.projects.locations.folders.getIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsFoldersGetIamPolicy : GTLRDataformQuery - -/** - * Optional. The maximum policy version that will be used to format the policy. - * Valid values are 0, 1, and 3. Requests specifying an invalid value will be - * rejected. Requests for policies with any conditional role bindings must - * specify version 3. Policies with no conditional role bindings may specify - * any valid value or leave the field unset. The policy in the response might - * use the policy version that you specified, or it might use a lower policy - * version. For example, if you specify version 3, but the policy has no - * conditional role bindings, the response uses version 1. To learn which - * resources support conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ -@property(nonatomic, assign) NSInteger optionsRequestedPolicyVersion; - -/** - * REQUIRED: The resource for which the policy is being requested. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * @param resource REQUIRED: The resource for which the policy is being - * requested. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsFoldersGetIamPolicy - */ -+ (instancetype)queryWithResource:(NSString *)resource; - -@end - -/** - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * Method: dataform.projects.locations.folders.setIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsFoldersSetIamPolicy : GTLRDataformQuery - -/** - * REQUIRED: The resource for which the policy is being specified. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * @param object The @c GTLRDataform_SetIamPolicyRequest to include in the - * query. - * @param resource REQUIRED: The resource for which the policy is being - * specified. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsFoldersSetIamPolicy - */ -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource; - -@end - -/** - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * Method: dataform.projects.locations.folders.testIamPermissions - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsFoldersTestIamPermissions : GTLRDataformQuery - -/** - * 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. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_TestIamPermissionsResponse. - * - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * @param object The @c GTLRDataform_TestIamPermissionsRequest to include in - * the query. - * @param resource 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. - * - * @return GTLRDataformQuery_ProjectsLocationsFoldersTestIamPermissions - */ -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource; - -@end - /** * Gets information about a location. * @@ -843,56 +707,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * Method: dataform.projects.locations.repositories.getIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsRepositoriesGetIamPolicy : GTLRDataformQuery - -/** - * Optional. The maximum policy version that will be used to format the policy. - * Valid values are 0, 1, and 3. Requests specifying an invalid value will be - * rejected. Requests for policies with any conditional role bindings must - * specify version 3. Policies with no conditional role bindings may specify - * any valid value or leave the field unset. The policy in the response might - * use the policy version that you specified, or it might use a lower policy - * version. For example, if you specify version 3, but the policy has no - * conditional role bindings, the response uses version 1. To learn which - * resources support conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ -@property(nonatomic, assign) NSInteger optionsRequestedPolicyVersion; - -/** - * REQUIRED: The resource for which the policy is being requested. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * @param resource REQUIRED: The resource for which the policy is being - * requested. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsRepositoriesGetIamPolicy - */ -+ (instancetype)queryWithResource:(NSString *)resource; - -@end - /** * Lists Repositories in a given project and location. **Note:** *This method * can return repositories not shown in the [Dataform @@ -1288,92 +1102,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * Method: dataform.projects.locations.repositories.setIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsRepositoriesSetIamPolicy : GTLRDataformQuery - -/** - * REQUIRED: The resource for which the policy is being specified. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * @param object The @c GTLRDataform_SetIamPolicyRequest to include in the - * query. - * @param resource REQUIRED: The resource for which the policy is being - * specified. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsRepositoriesSetIamPolicy - */ -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource; - -@end - -/** - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * Method: dataform.projects.locations.repositories.testIamPermissions - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsRepositoriesTestIamPermissions : GTLRDataformQuery - -/** - * 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. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_TestIamPermissionsResponse. - * - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * @param object The @c GTLRDataform_TestIamPermissionsRequest to include in - * the query. - * @param resource 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. - * - * @return GTLRDataformQuery_ProjectsLocationsRepositoriesTestIamPermissions - */ -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource; - -@end - /** * Creates a new WorkflowConfig in a given Repository. * @@ -2004,56 +1732,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * Method: dataform.projects.locations.repositories.workspaces.getIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesGetIamPolicy : GTLRDataformQuery - -/** - * Optional. The maximum policy version that will be used to format the policy. - * Valid values are 0, 1, and 3. Requests specifying an invalid value will be - * rejected. Requests for policies with any conditional role bindings must - * specify version 3. Policies with no conditional role bindings may specify - * any valid value or leave the field unset. The policy in the response might - * use the policy version that you specified, or it might use a lower policy - * version. For example, if you specify version 3, but the policy has no - * conditional role bindings, the response uses version 1. To learn which - * resources support conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ -@property(nonatomic, assign) NSInteger optionsRequestedPolicyVersion; - -/** - * REQUIRED: The resource for which the policy is being requested. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * @param resource REQUIRED: The resource for which the policy is being - * requested. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesGetIamPolicy - */ -+ (instancetype)queryWithResource:(NSString *)resource; - -@end - /** * Installs dependency NPM packages (inside a Workspace). * @@ -2528,92 +2206,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * Method: dataform.projects.locations.repositories.workspaces.setIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesSetIamPolicy : GTLRDataformQuery - -/** - * REQUIRED: The resource for which the policy is being specified. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * @param object The @c GTLRDataform_SetIamPolicyRequest to include in the - * query. - * @param resource REQUIRED: The resource for which the policy is being - * specified. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesSetIamPolicy - */ -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource; - -@end - -/** - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * Method: dataform.projects.locations.repositories.workspaces.testIamPermissions - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesTestIamPermissions : GTLRDataformQuery - -/** - * 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. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_TestIamPermissionsResponse. - * - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * @param object The @c GTLRDataform_TestIamPermissionsRequest to include in - * the query. - * @param resource 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. - * - * @return GTLRDataformQuery_ProjectsLocationsRepositoriesWorkspacesTestIamPermissions - */ -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource; - -@end - /** * Writes to a file (inside a Workspace). * @@ -2643,142 +2235,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * Method: dataform.projects.locations.teamFolders.getIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsTeamFoldersGetIamPolicy : GTLRDataformQuery - -/** - * Optional. The maximum policy version that will be used to format the policy. - * Valid values are 0, 1, and 3. Requests specifying an invalid value will be - * rejected. Requests for policies with any conditional role bindings must - * specify version 3. Policies with no conditional role bindings may specify - * any valid value or leave the field unset. The policy in the response might - * use the policy version that you specified, or it might use a lower policy - * version. For example, if you specify version 3, but the policy has no - * conditional role bindings, the response uses version 1. To learn which - * resources support conditions in their IAM policies, see the [IAM - * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ -@property(nonatomic, assign) NSInteger optionsRequestedPolicyVersion; - -/** - * REQUIRED: The resource for which the policy is being requested. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Gets the access control policy for a resource. Returns an empty policy if - * the resource exists and does not have a policy set. - * - * @param resource REQUIRED: The resource for which the policy is being - * requested. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsTeamFoldersGetIamPolicy - */ -+ (instancetype)queryWithResource:(NSString *)resource; - -@end - -/** - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * Method: dataform.projects.locations.teamFolders.setIamPolicy - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsTeamFoldersSetIamPolicy : GTLRDataformQuery - -/** - * REQUIRED: The resource for which the policy is being specified. See - * [Resource names](https://cloud.google.com/apis/design/resource_names) for - * the appropriate value for this field. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_Policy. - * - * Sets the access control policy on the specified resource. Replaces any - * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - * `PERMISSION_DENIED` errors. - * - * @param object The @c GTLRDataform_SetIamPolicyRequest to include in the - * query. - * @param resource REQUIRED: The resource for which the policy is being - * specified. See [Resource - * names](https://cloud.google.com/apis/design/resource_names) for the - * appropriate value for this field. - * - * @return GTLRDataformQuery_ProjectsLocationsTeamFoldersSetIamPolicy - */ -+ (instancetype)queryWithObject:(GTLRDataform_SetIamPolicyRequest *)object - resource:(NSString *)resource; - -@end - -/** - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * Method: dataform.projects.locations.teamFolders.testIamPermissions - * - * Authorization scope(s): - * @c kGTLRAuthScopeDataformBigquery - * @c kGTLRAuthScopeDataformCloudPlatform - */ -@interface GTLRDataformQuery_ProjectsLocationsTeamFoldersTestIamPermissions : GTLRDataformQuery - -/** - * 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. - */ -@property(nonatomic, copy, nullable) NSString *resource; - -/** - * Fetches a @c GTLRDataform_TestIamPermissionsResponse. - * - * Returns permissions that a caller has on the specified resource. If the - * resource does not exist, this will return an empty set of permissions, not a - * `NOT_FOUND` error. Note: This operation is designed to be used for building - * permission-aware UIs and command-line tools, not for authorization checking. - * This operation may "fail open" without warning. - * - * @param object The @c GTLRDataform_TestIamPermissionsRequest to include in - * the query. - * @param resource 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. - * - * @return GTLRDataformQuery_ProjectsLocationsTeamFoldersTestIamPermissions - */ -+ (instancetype)queryWithObject:(GTLRDataform_TestIamPermissionsRequest *)object - resource:(NSString *)resource; - -@end - /** * Update default config for a given project and location. **Note:** *This * method does not fully implement [AIP/134](https://google.aip.dev/134). The diff --git a/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectObjects.m b/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectObjects.m index 75268b793..9df665811 100644 --- a/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectObjects.m +++ b/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectObjects.m @@ -710,11 +710,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRDeveloperConnect_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRDeveloperConnect_Operation class] + @"operations" : [GTLRDeveloperConnect_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectQuery.m b/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectQuery.m index 5cab960aa..177193891 100644 --- a/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectQuery.m +++ b/Sources/GeneratedServices/DeveloperConnect/GTLRDeveloperConnectQuery.m @@ -926,7 +926,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDeveloperConnectQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectObjects.h b/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectObjects.h index fb745e5d8..65fbeabd2 100644 --- a/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectObjects.h +++ b/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectObjects.h @@ -1468,6 +1468,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDeveloperConnect_RuntimeConfig_State_Unl */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectQuery.h b/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectQuery.h index 6f9e7e7eb..86d32b01b 100644 --- a/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectQuery.h +++ b/Sources/GeneratedServices/DeveloperConnect/Public/GoogleAPIClientForREST/GTLRDeveloperConnectQuery.h @@ -1729,6 +1729,17 @@ FOUNDATION_EXTERN NSString * const kGTLRDeveloperConnectRefTypeTag; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDeveloperConnect_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Dialogflow/GTLRDialogflowObjects.m b/Sources/GeneratedServices/Dialogflow/GTLRDialogflowObjects.m index f26fd165c..0eea30bc4 100644 --- a/Sources/GeneratedServices/Dialogflow/GTLRDialogflowObjects.m +++ b/Sources/GeneratedServices/Dialogflow/GTLRDialogflowObjects.m @@ -696,6 +696,11 @@ NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1TelephonyDtmfEvents_DtmfEvents_DtmfZero = @"DTMF_ZERO"; NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1TelephonyDtmfEvents_DtmfEvents_TelephonyDtmfUnspecified = @"TELEPHONY_DTMF_UNSPECIFIED"; +// GTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall.state +NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_NeedsConfirmation = @"NEEDS_CONFIRMATION"; +NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_Triggered = @"TRIGGERED"; + // GTLRDialogflow_GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata.participantRole NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata_ParticipantRole_AutomatedAgent = @"AUTOMATED_AGENT"; NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata_ParticipantRole_EndUser = @"END_USER"; @@ -856,6 +861,11 @@ NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2StreamingRecognitionResult_MessageType_MessageTypeUnspecified = @"MESSAGE_TYPE_UNSPECIFIED"; NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2StreamingRecognitionResult_MessageType_Transcript = @"TRANSCRIPT"; +// GTLRDialogflow_GoogleCloudDialogflowV2ToolCall.state +NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_NeedsConfirmation = @"NEEDS_CONFIRMATION"; +NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_Triggered = @"TRIGGERED"; + // GTLRDialogflow_GoogleCloudDialogflowV3alpha1TurnSignals.failureReasons NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1TurnSignals_FailureReasons_FailedIntent = @"FAILED_INTENT"; NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1TurnSignals_FailureReasons_FailedWebhook = @"FAILED_WEBHOOK"; @@ -7023,6 +7033,131 @@ @implementation GTLRDialogflow_GoogleCloudDialogflowCxV3WebhookServiceDirectoryC @end +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstruction +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstruction +@dynamic agentAction, condition, displayDetails, displayName, + duplicateCheckResult, systemAction; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult +@dynamic duplicateSuggestions; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"duplicateSuggestions" : [GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion +@dynamic answerRecord, similarityScore, suggestionIndex; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestion +@dynamic agentActionSuggestions, applicableInstructions, sampleResponses; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"agentActionSuggestions" : [GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion class], + @"applicableInstructions" : [GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstruction class], + @"sampleResponses" : [GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion +@dynamic agentAction, duplicateCheckResult, sources; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult +@dynamic duplicateSuggestions; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"duplicateSuggestions" : [GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion +@dynamic answerRecord, similarityScore, sources, suggestionIndex; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse +@dynamic duplicateCheckResult, responseText, sources; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources +@dynamic instructionIndexes; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"instructionIndexes" : [NSNumber class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDialogflow_GoogleCloudDialogflowV2AnnotatedMessagePart @@ -7111,6 +7246,131 @@ @implementation GTLRDialogflow_GoogleCloudDialogflowV2BatchUpdateIntentsResponse @end +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstruction +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstruction +@dynamic agentAction, condition, displayDetails, displayName, + duplicateCheckResult, systemAction; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult +@dynamic duplicateSuggestions; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"duplicateSuggestions" : [GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion +@dynamic answerRecord, similarityScore, suggestionIndex; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestion +@dynamic agentActionSuggestions, applicableInstructions, sampleResponses; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"agentActionSuggestions" : [GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion class], + @"applicableInstructions" : [GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstruction class], + @"sampleResponses" : [GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion +@dynamic agentAction, duplicateCheckResult, sources; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult +@dynamic duplicateSuggestions; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"duplicateSuggestions" : [GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion +@dynamic answerRecord, similarityScore, sources, suggestionIndex; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse +@dynamic duplicateCheckResult, responseText, sources; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources +// + +@implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources +@dynamic instructionIndexes; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"instructionIndexes" : [NSNumber class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDialogflow_GoogleCloudDialogflowV2beta1AnnotatedMessagePart @@ -7420,7 +7680,8 @@ @implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1GenerateSuggestionsRe // @implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1GeneratorSuggestion -@dynamic freeFormSuggestion, summarySuggestion, toolCallInfo; +@dynamic agentCoachingSuggestion, freeFormSuggestion, summarySuggestion, + toolCallInfo; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -8786,7 +9047,8 @@ @implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1TelephonyDtmfEvents // @implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall -@dynamic action, createTime, inputParameters, tool; +@dynamic action, answerRecord, createTime, inputParameters, state, tool, + toolDisplayDetails, toolDisplayName; @end @@ -8810,7 +9072,7 @@ + (Class)classForAdditionalProperties { // @implementation GTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCallResult -@dynamic action, content, createTime, error, rawContent, tool; +@dynamic action, answerRecord, content, createTime, error, rawContent, tool; @end @@ -9179,7 +9441,8 @@ @implementation GTLRDialogflow_GoogleCloudDialogflowV2GenerateSuggestionsRespons // @implementation GTLRDialogflow_GoogleCloudDialogflowV2GeneratorSuggestion -@dynamic freeFormSuggestion, summarySuggestion, toolCallInfo; +@dynamic agentCoachingSuggestion, freeFormSuggestion, summarySuggestion, + toolCallInfo; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -10221,7 +10484,8 @@ @implementation GTLRDialogflow_GoogleCloudDialogflowV2SummarySuggestionSummarySe // @implementation GTLRDialogflow_GoogleCloudDialogflowV2ToolCall -@dynamic action, createTime, inputParameters, tool; +@dynamic action, answerRecord, createTime, inputParameters, state, tool, + toolDisplayDetails, toolDisplayName; @end @@ -10245,7 +10509,7 @@ + (Class)classForAdditionalProperties { // @implementation GTLRDialogflow_GoogleCloudDialogflowV2ToolCallResult -@dynamic action, content, createTime, error, rawContent, tool; +@dynamic action, answerRecord, content, createTime, error, rawContent, tool; @end @@ -10411,11 +10675,12 @@ + (Class)classForAdditionalProperties { // @implementation GTLRDialogflow_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRDialogflow_GoogleLongrunningOperation class] + @"operations" : [GTLRDialogflow_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Dialogflow/GTLRDialogflowQuery.m b/Sources/GeneratedServices/Dialogflow/GTLRDialogflowQuery.m index d0d288749..24e473971 100644 --- a/Sources/GeneratedServices/Dialogflow/GTLRDialogflowQuery.m +++ b/Sources/GeneratedServices/Dialogflow/GTLRDialogflowQuery.m @@ -3472,7 +3472,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDialogflowQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -3640,7 +3640,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDialogflowQuery_ProjectsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowObjects.h b/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowObjects.h index 056356659..348365c01 100644 --- a/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowObjects.h +++ b/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowObjects.h @@ -346,10 +346,28 @@ @class GTLRDialogflow_GoogleCloudDialogflowCxV3WebhookResponse_Payload; @class GTLRDialogflow_GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse; @class GTLRDialogflow_GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstruction; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse; +@class GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources; @class GTLRDialogflow_GoogleCloudDialogflowV2AnnotatedMessagePart; @class GTLRDialogflow_GoogleCloudDialogflowV2ArticleAnswer; @class GTLRDialogflow_GoogleCloudDialogflowV2ArticleAnswer_Metadata; @class GTLRDialogflow_GoogleCloudDialogflowV2ArticleSuggestionModelMetadata; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstruction; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse; +@class GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources; @class GTLRDialogflow_GoogleCloudDialogflowV2beta1AnnotatedMessagePart; @class GTLRDialogflow_GoogleCloudDialogflowV2beta1ArticleAnswer; @class GTLRDialogflow_GoogleCloudDialogflowV2beta1ArticleAnswer_Metadata; @@ -4026,6 +4044,28 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1T */ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1TelephonyDtmfEvents_DtmfEvents_TelephonyDtmfUnspecified; +// ---------------------------------------------------------------------------- +// GTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall.state + +/** + * The tool call requires confirmation from a human. + * + * Value: "NEEDS_CONFIRMATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_NeedsConfirmation; +/** + * Default value. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_StateUnspecified; +/** + * The tool call has been triggered. + * + * Value: "TRIGGERED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_Triggered; + // ---------------------------------------------------------------------------- // GTLRDialogflow_GoogleCloudDialogflowV2ClearSuggestionFeatureConfigOperationMetadata.participantRole @@ -4848,6 +4888,28 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2Stream */ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2StreamingRecognitionResult_MessageType_Transcript; +// ---------------------------------------------------------------------------- +// GTLRDialogflow_GoogleCloudDialogflowV2ToolCall.state + +/** + * The tool call requires confirmation from a human. + * + * Value: "NEEDS_CONFIRMATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_NeedsConfirmation; +/** + * Default value. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_StateUnspecified; +/** + * The tool call has been triggered. + * + * Value: "TRIGGERED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_Triggered; + // ---------------------------------------------------------------------------- // GTLRDialogflow_GoogleCloudDialogflowV3alpha1TurnSignals.failureReasons @@ -17671,6 +17733,193 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 @end +/** + * Agent Coaching instructions that customer can configure. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstruction : GTLRObject + +/** + * Optional. The action that human agent should take. For example, "apologize + * for the slow shipping". If the users only want to use agent coaching for + * intent detection, agent_action can be empty + */ +@property(nonatomic, copy, nullable) NSString *agentAction; + +/** + * Optional. The condition of the instruction. For example, "the customer wants + * to cancel an order". If the users want the instruction to be triggered + * unconditionally, the condition can be empty. + */ +@property(nonatomic, copy, nullable) NSString *condition; + +/** Optional. The detailed description of this instruction. */ +@property(nonatomic, copy, nullable) NSString *displayDetails; + +/** Optional. Display name for the instruction. */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** Output only. Duplication check for the AgentCoachingInstruction. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult *duplicateCheckResult; + +/** + * Optional. The action that system should take. For example, "call + * GetOrderTime with order_number={order number provided by the customer}". If + * the users don't have plugins or don't want to trigger plugins, the + * system_action can be empty + */ +@property(nonatomic, copy, nullable) NSString *systemAction; + +@end + + +/** + * Duplication check for the suggestion. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResult : GTLRObject + +/** Output only. The duplicate suggestions. */ +@property(nonatomic, strong, nullable) NSArray *duplicateSuggestions; + +@end + + +/** + * The duplicate suggestion details. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion : GTLRObject + +/** Output only. The answer record id of the past duplicate suggestion. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + +/** + * Output only. The similarity score of between the past and current + * suggestion. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *similarityScore; + +/** + * Output only. The index of the duplicate suggestion in the past suggestion + * list. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *suggestionIndex; + +@end + + +/** + * Suggestion for coaching agents. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestion : GTLRObject + +/** Optional. Suggested actions for the agent to take. */ +@property(nonatomic, strong, nullable) NSArray *agentActionSuggestions; + +/** Optional. Instructions applicable based on the current context. */ +@property(nonatomic, strong, nullable) NSArray *applicableInstructions; + +/** Optional. Sample response for the Agent. */ +@property(nonatomic, strong, nullable) NSArray *sampleResponses; + +@end + + +/** + * Actions suggested for the agent. This is based on applicable instructions. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionAgentActionSuggestion : GTLRObject + +/** Optional. The suggested action for the agent. */ +@property(nonatomic, copy, nullable) NSString *agentAction; + +/** Output only. Duplicate check result for the agent action suggestion. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult *duplicateCheckResult; + +/** Output only. Sources for the agent action suggestion. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources *sources; + +@end + + +/** + * Duplication check for the suggestion. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult : GTLRObject + +/** Output only. The duplicate suggestions. */ +@property(nonatomic, strong, nullable) NSArray *duplicateSuggestions; + +@end + + +/** + * The duplicate suggestion details. Keeping answer_record and sources together + * as they are identifiers for duplicate suggestions. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion : GTLRObject + +/** Output only. The answer record id of the past duplicate suggestion. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + +/** + * Output only. The similarity score of between the past and current + * suggestion. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *similarityScore; + +/** Output only. Sources for the suggestion. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources *sources; + +/** + * Output only. The index of the duplicate suggestion in the past suggestion + * list. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *suggestionIndex; + +@end + + +/** + * Sample response that the agent can use. This could be based on applicable + * instructions and ingested data from other systems. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSampleResponse : GTLRObject + +/** Output only. Duplicate check result for the sample response. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionDuplicateCheckResult *duplicateCheckResult; + +/** Optional. Sample response for Agent in text. */ +@property(nonatomic, copy, nullable) NSString *responseText; + +/** Output only. Sources for the Sample Response. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources *sources; + +@end + + +/** + * Sources for the suggestion. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestionSources : GTLRObject + +/** + * Output only. Source instruction indexes for the suggestion. This is the + * index of the applicable_instructions field. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSArray *instructionIndexes; + +@end + + /** * Represents a part of a message possibly annotated with an entity. The part * can be an entity or purely a part of the message between two entities or @@ -17798,6 +18047,193 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 @end +/** + * Agent Coaching instructions that customer can configure. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstruction : GTLRObject + +/** + * Optional. The action that human agent should take. For example, "apologize + * for the slow shipping". If the users only want to use agent coaching for + * intent detection, agent_action can be empty + */ +@property(nonatomic, copy, nullable) NSString *agentAction; + +/** + * Optional. The condition of the instruction. For example, "the customer wants + * to cancel an order". If the users want the instruction to be triggered + * unconditionally, the condition can be empty. + */ +@property(nonatomic, copy, nullable) NSString *condition; + +/** Optional. The detailed description of this instruction. */ +@property(nonatomic, copy, nullable) NSString *displayDetails; + +/** Optional. Display name for the instruction. */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** Output only. Duplication check for the AgentCoachingInstruction. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult *duplicateCheckResult; + +/** + * Optional. The action that system should take. For example, "call + * GetOrderTime with order_number={order number provided by the customer}". If + * the users don't have plugins or don't want to trigger plugins, the + * system_action can be empty + */ +@property(nonatomic, copy, nullable) NSString *systemAction; + +@end + + +/** + * Duplication check for the suggestion. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResult : GTLRObject + +/** Output only. The duplicate suggestions. */ +@property(nonatomic, strong, nullable) NSArray *duplicateSuggestions; + +@end + + +/** + * The duplicate suggestion details. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingInstructionDuplicateCheckResultDuplicateSuggestion : GTLRObject + +/** Output only. The answer record id of the past duplicate suggestion. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + +/** + * Output only. The similarity score of between the past and current + * suggestion. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *similarityScore; + +/** + * Output only. The index of the duplicate suggestion in the past suggestion + * list. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *suggestionIndex; + +@end + + +/** + * Suggestion for coaching agents. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestion : GTLRObject + +/** Optional. Suggested actions for the agent to take. */ +@property(nonatomic, strong, nullable) NSArray *agentActionSuggestions; + +/** Optional. Instructions applicable based on the current context. */ +@property(nonatomic, strong, nullable) NSArray *applicableInstructions; + +/** Optional. Sample response for the Agent. */ +@property(nonatomic, strong, nullable) NSArray *sampleResponses; + +@end + + +/** + * Actions suggested for the agent. This is based on applicable instructions. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionAgentActionSuggestion : GTLRObject + +/** Optional. The suggested action for the agent. */ +@property(nonatomic, copy, nullable) NSString *agentAction; + +/** Output only. Duplicate check result for the agent action suggestion. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult *duplicateCheckResult; + +/** Output only. Sources for the agent action suggestion. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources *sources; + +@end + + +/** + * Duplication check for the suggestion. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult : GTLRObject + +/** Output only. The duplicate suggestions. */ +@property(nonatomic, strong, nullable) NSArray *duplicateSuggestions; + +@end + + +/** + * The duplicate suggestion details. Keeping answer_record and sources together + * as they are identifiers for duplicate suggestions. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResultDuplicateSuggestion : GTLRObject + +/** Output only. The answer record id of the past duplicate suggestion. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + +/** + * Output only. The similarity score of between the past and current + * suggestion. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *similarityScore; + +/** Output only. Sources for the suggestion. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources *sources; + +/** + * Output only. The index of the duplicate suggestion in the past suggestion + * list. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *suggestionIndex; + +@end + + +/** + * Sample response that the agent can use. This could be based on applicable + * instructions and ingested data from other systems. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSampleResponse : GTLRObject + +/** Output only. Duplicate check result for the sample response. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionDuplicateCheckResult *duplicateCheckResult; + +/** Optional. Sample response for Agent in text. */ +@property(nonatomic, copy, nullable) NSString *responseText; + +/** Output only. Sources for the Sample Response. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources *sources; + +@end + + +/** + * Sources for the suggestion. + */ +@interface GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestionSources : GTLRObject + +/** + * Output only. Source instruction indexes for the suggestion. This is the + * index of the applicable_instructions field. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSArray *instructionIndexes; + +@end + + /** * Represents a part of a message possibly annotated with an entity. The part * can be an entity or purely a part of the message between two entities or @@ -18462,6 +18898,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 */ @interface GTLRDialogflow_GoogleCloudDialogflowV2beta1GeneratorSuggestion : GTLRObject +/** Optional. Suggestion to coach the agent. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1AgentCoachingSuggestion *agentCoachingSuggestion; + /** Optional. Free form suggestion. */ @property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1FreeFormSuggestion *freeFormSuggestion; @@ -21186,18 +21625,43 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 /** Optional. The name of the tool's action associated with this call. */ @property(nonatomic, copy, nullable) NSString *action; +/** Optional. The answer record associated with this tool call. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + /** Output only. Create time of the tool call. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** Optional. The action's input parameters. */ @property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_InputParameters *inputParameters; +/** + * Output only. State of the tool call + * + * Likely values: + * @arg @c kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_NeedsConfirmation + * The tool call requires confirmation from a human. (Value: + * "NEEDS_CONFIRMATION") + * @arg @c kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDialogflow_GoogleCloudDialogflowV2beta1ToolCall_State_Triggered + * The tool call has been triggered. (Value: "TRIGGERED") + */ +@property(nonatomic, copy, nullable) NSString *state; + /** * Optional. The tool associated with this call. Format: * `projects//locations//tools/`. */ @property(nonatomic, copy, nullable) NSString *tool; +/** Optional. A human readable description of the tool. */ +@property(nonatomic, copy, nullable) NSString *toolDisplayDetails; + +/** + * Optional. A human readable short name of the tool, to be shown on the UI. + */ +@property(nonatomic, copy, nullable) NSString *toolDisplayName; + @end @@ -21221,6 +21685,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 /** Optional. The name of the tool's action associated with this call. */ @property(nonatomic, copy, nullable) NSString *action; +/** Optional. The answer record associated with this tool call result. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + /** Only populated if the response content is utf-8 encoded. */ @property(nonatomic, copy, nullable) NSString *content; @@ -22193,6 +22660,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 */ @interface GTLRDialogflow_GoogleCloudDialogflowV2GeneratorSuggestion : GTLRObject +/** Optional. Suggestion to coach the agent. */ +@property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2AgentCoachingSuggestion *agentCoachingSuggestion; + /** Optional. Free form suggestion. */ @property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2FreeFormSuggestion *freeFormSuggestion; @@ -24302,18 +24772,43 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 /** Optional. The name of the tool's action associated with this call. */ @property(nonatomic, copy, nullable) NSString *action; +/** Optional. The answer record associated with this tool call. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + /** Output only. Create time of the tool call. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** Optional. The action's input parameters. */ @property(nonatomic, strong, nullable) GTLRDialogflow_GoogleCloudDialogflowV2ToolCall_InputParameters *inputParameters; +/** + * Output only. State of the tool call. + * + * Likely values: + * @arg @c kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_NeedsConfirmation + * The tool call requires confirmation from a human. (Value: + * "NEEDS_CONFIRMATION") + * @arg @c kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDialogflow_GoogleCloudDialogflowV2ToolCall_State_Triggered + * The tool call has been triggered. (Value: "TRIGGERED") + */ +@property(nonatomic, copy, nullable) NSString *state; + /** * Optional. The tool associated with this call. Format: * `projects//locations//tools/`. */ @property(nonatomic, copy, nullable) NSString *tool; +/** Optional. A human readable description of the tool. */ +@property(nonatomic, copy, nullable) NSString *toolDisplayDetails; + +/** + * Optional. A human readable short name of the tool, to be shown on the UI. + */ +@property(nonatomic, copy, nullable) NSString *toolDisplayName; + @end @@ -24337,6 +24832,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 /** Optional. The name of the tool's action associated with this call. */ @property(nonatomic, copy, nullable) NSString *action; +/** Optional. The answer record associated with this tool call result. */ +@property(nonatomic, copy, nullable) NSString *answerRecord; + /** Only populated if the response content is utf-8 encoded. */ @property(nonatomic, copy, nullable) NSString *content; @@ -24726,6 +25224,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflow_GoogleCloudDialogflowV3alpha1 */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowQuery.h b/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowQuery.h index 209e81aeb..1e4106296 100644 --- a/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowQuery.h +++ b/Sources/GeneratedServices/Dialogflow/Public/GoogleAPIClientForREST/GTLRDialogflowQuery.h @@ -6424,8 +6424,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflowViewTestCaseViewUnspecified; @interface GTLRDialogflowQuery_ProjectsLocationsList : GTLRDialogflowQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -6566,6 +6566,17 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflowViewTestCaseViewUnspecified; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDialogflow_GoogleLongrunningListOperationsResponse. * @@ -6873,6 +6884,17 @@ FOUNDATION_EXTERN NSString * const kGTLRDialogflowViewTestCaseViewUnspecified; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDialogflow_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryObjects.h b/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryObjects.h index 830ffba31..bca2cda8c 100644 --- a/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryObjects.h +++ b/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryObjects.h @@ -2145,7 +2145,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDirectory_RoleAssignment_AssigneeType_Us @property(nonatomic, copy, nullable) NSString *osVersion; /** - * Output only. Compliance status of the OS version. + * Output only. Device policy compliance status of the OS version. * * Likely values: * @arg @c kGTLRDirectory_ChromeOsDevice_OsVersionCompliance_ComplianceUnspecified diff --git a/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryQuery.h b/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryQuery.h index b3cc80d1b..b6a9a7811 100644 --- a/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryQuery.h +++ b/Sources/GeneratedServices/Directory/Public/GoogleAPIClientForREST/GTLRDirectoryQuery.h @@ -2115,8 +2115,9 @@ GTLR_DEPRECATED @property(nonatomic, copy, nullable) NSString *pageToken; /** - * Query string search. Should be of the form "". Complete documentation is at - * https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups + * Query string search. Contains one or more search clauses, each with a field, + * operator, and value. For complete documentation, go to [Search for + * groups](https://developers.google.com/workspace/admin/directory/v1/guides/search-groups). */ @property(nonatomic, copy, nullable) NSString *query; @@ -3580,15 +3581,16 @@ GTLR_DEPRECATED @property(nonatomic, copy, nullable) NSString *pageToken; /** - * String query used to filter results. Should be of the form "field operator - * value" where field can be any of supported fields and operators can be any - * of supported operations. Operators include '=' for exact match, '!=' for - * mismatch and ':' for prefix match or HAS match where applicable. For prefix - * match, the value should always be followed by a *. Logical operators NOT and - * AND are supported (in this order of precedence). Supported fields include - * `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, - * `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For - * example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`. + * String query used to filter results. Contains one or more search clauses, + * each with a field, operator, and value. A field can be any of supported + * fields and operators can be any of supported operations. Operators include + * '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match + * where applicable. For prefix match, the value should always be followed by a + * *. Logical operators NOT and AND are supported (in this order of + * precedence). Supported fields include `generatedResourceName`, `name`, + * `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, + * `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND + * featureInstances.feature.name:Phone`. */ @property(nonatomic, copy, nullable) NSString *query; @@ -5581,8 +5583,9 @@ GTLR_DEPRECATED @property(nonatomic, copy, nullable) NSString *projection; /** - * Query string search. Should be of the form "". Complete documentation is at - * https: //developers.google.com/admin-sdk/directory/v1/guides/search-users + * Query string search. Contains one or more search clauses, each with a field, + * operator, and value. For complete documentation, go to [Search for + * users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users). */ @property(nonatomic, copy, nullable) NSString *query; diff --git a/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineObjects.m b/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineObjects.m index 5bd4bcc26..c85525c92 100644 --- a/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineObjects.m +++ b/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineObjects.m @@ -61,11 +61,26 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_PersonTypeUnspecified = @"PERSON_TYPE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_ThirdPartyIdentity = @"THIRD_PARTY_IDENTITY"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment.enrollState +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_Declined = @"DECLINED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_Enrolled = @"ENROLLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified = @"ENROLL_STATES_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment.enrollState +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined = @"DECLINED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled = @"ENROLLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified = @"ENROLL_STATE_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.enrollState NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_Declined = @"DECLINED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_Enrolled = @"ENROLLED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified = @"ENROLL_STATES_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment.enrollState +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined = @"DECLINED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled = @"ENROLLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified = @"ENROLL_STATE_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer.answerSkippedReasons NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_AnswerSkippedReasons_AdversarialQueryIgnored = @"ADVERSARIAL_QUERY_IGNORED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_AnswerSkippedReasons_AnswerSkippedReasonUnspecified = @"ANSWER_SKIPPED_REASON_UNSPECIFIED"; @@ -106,6 +121,29 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_Succeeded = @"SUCCEEDED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer.assistSkippedReasons +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_AssistSkippedReasons_AssistSkippedReasonUnspecified = @"ASSIST_SKIPPED_REASON_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_AssistSkippedReasons_CustomerPolicyViolation = @"CUSTOMER_POLICY_VIOLATION"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_AssistSkippedReasons_NonAssistSeekingQueryIgnored = @"NON_ASSIST_SEEKING_QUERY_IGNORED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer.state +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Failed = @"FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_InProgress = @"IN_PROGRESS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Skipped = @"SKIPPED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Succeeded = @"SUCCEEDED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult.verdict +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Allow = @"ALLOW"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Block = @"BLOCK"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Unspecified = @"UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult.outcome +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeDeadlineExceeded = @"OUTCOME_DEADLINE_EXCEEDED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeFailed = @"OUTCOME_FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeOk = @"OUTCOME_OK"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeUnspecified = @"OUTCOME_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig.supportedConnectorModes NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig_SupportedConnectorModes_Actions = @"ACTIONS"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig_SupportedConnectorModes_ConnectorModeUnspecified = @"CONNECTOR_MODE_UNSPECIFIED"; @@ -125,6 +163,7 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleted = @"DELETED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_DeleteFailed = @"DELETE_FAILED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleting = @"DELETING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Expired = @"EXPIRED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_KeyIssue = @"KEY_ISSUE"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Unusable = @"UNUSABLE"; @@ -255,6 +294,11 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSetupError = @"STREAMING_SETUP_ERROR"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError = @"STREAMING_SYNC_ERROR"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore.configurableBillingApproach +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified = @"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding = @"CONFIGURABLE_CONSUMPTION_EMBEDDING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore = @"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore.contentConfig NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_ContentConfigUnspecified = @"CONTENT_CONFIG_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_ContentRequired = @"CONTENT_REQUIRED"; @@ -279,6 +323,10 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeIntranet = @"APP_TYPE_INTRANET"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeUnspecified = @"APP_TYPE_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine.configurableBillingApproach +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled = @"CONFIGURABLE_BILLING_APPROACH_ENABLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified = @"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine.industryVertical NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_Generic = @"GENERIC"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_HealthcareFhir = @"HEALTHCARE_FHIR"; @@ -381,6 +429,32 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_IdpTypeUnspecified = @"IDP_TYPE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_ThirdParty = @"THIRD_PARTY"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig.state +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_Active = @"ACTIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_Expired = @"EXPIRED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_NotStarted = @"NOT_STARTED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_StateUnspecified = @"STATE_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig.subscriptionTerm +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth = @"SUBSCRIPTION_TERM_ONE_MONTH"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermOneYear = @"SUBSCRIPTION_TERM_ONE_YEAR"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears = @"SUBSCRIPTION_TERM_THREE_YEARS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified = @"SUBSCRIPTION_TERM_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig.subscriptionTier +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness = @"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter = @"SUBSCRIPTION_TIER_AGENTSPACE_STARTER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEdu = @"SUBSCRIPTION_TIER_EDU"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging = @"SUBSCRIPTION_TIER_EDU_EMERGING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduPro = @"SUBSCRIPTION_TIER_EDU_PRO"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging = @"SUBSCRIPTION_TIER_EDU_PRO_EMERGING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEnterprise = @"SUBSCRIPTION_TIER_ENTERPRISE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker = @"SUBSCRIPTION_TIER_FRONTLINE_WORKER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm = @"SUBSCRIPTION_TIER_NOTEBOOK_LM"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierSearch = @"SUBSCRIPTION_TIER_SEARCH"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant = @"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierUnspecified = @"SUBSCRIPTION_TIER_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig.mode NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_Disabled = @"DISABLED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_Enabled = @"ENABLED"; @@ -660,12 +734,23 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig_FailureMode_FailOpen = @"FAIL_OPEN"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig_FailureMode_FailureModeUnspecified = @"FAILURE_MODE_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig.supportedConnectorModes +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_Actions = @"ACTIONS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_ConnectorModeUnspecified = @"CONNECTOR_MODE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_DataIngestion = @"DATA_INGESTION"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_EndUserAuthentication = @"END_USER_AUTHENTICATION"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata.state NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_Indexed = @"INDEXED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_NotInIndex = @"NOT_IN_INDEX"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_NotInTargetSite = @"NOT_IN_TARGET_SITE"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_StateUnspecified = @"STATE_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment.enrollState +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined = @"DECLINED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled = @"ENROLLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified = @"ENROLL_STATE_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig.notebooklmState NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmNotEnabled = @"NOTEBOOK_LM_NOT_ENABLED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmNotReady = @"NOTEBOOK_LM_NOT_READY"; @@ -679,6 +764,7 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleted = @"DELETED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_DeleteFailed = @"DELETE_FAILED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleting = @"DELETING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Expired = @"EXPIRED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_KeyIssue = @"KEY_ISSUE"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Unusable = @"UNUSABLE"; @@ -704,6 +790,11 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified = @"INTERPOLATION_TYPE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_Linear = @"LINEAR"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore.configurableBillingApproach +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified = @"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding = @"CONFIGURABLE_CONSUMPTION_EMBEDDING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore = @"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore.contentConfig NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_ContentConfigUnspecified = @"CONTENT_CONFIG_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_ContentRequired = @"CONTENT_REQUIRED"; @@ -728,6 +819,10 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeIntranet = @"APP_TYPE_INTRANET"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeUnspecified = @"APP_TYPE_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine.configurableBillingApproach +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled = @"CONFIGURABLE_BILLING_APPROACH_ENABLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified = @"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine.industryVertical NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_Generic = @"GENERIC"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_HealthcareFhir = @"HEALTHCARE_FHIR"; @@ -772,6 +867,32 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_IdpTypeUnspecified = @"IDP_TYPE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_ThirdParty = @"THIRD_PARTY"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig.state +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_Active = @"ACTIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_Expired = @"EXPIRED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_NotStarted = @"NOT_STARTED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_StateUnspecified = @"STATE_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig.subscriptionTerm +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth = @"SUBSCRIPTION_TERM_ONE_MONTH"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermOneYear = @"SUBSCRIPTION_TERM_ONE_YEAR"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears = @"SUBSCRIPTION_TERM_THREE_YEARS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified = @"SUBSCRIPTION_TERM_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig.subscriptionTier +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness = @"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter = @"SUBSCRIPTION_TIER_AGENTSPACE_STARTER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEdu = @"SUBSCRIPTION_TIER_EDU"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging = @"SUBSCRIPTION_TIER_EDU_EMERGING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduPro = @"SUBSCRIPTION_TIER_EDU_PRO"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging = @"SUBSCRIPTION_TIER_EDU_PRO_EMERGING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEnterprise = @"SUBSCRIPTION_TIER_ENTERPRISE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker = @"SUBSCRIPTION_TIER_FRONTLINE_WORKER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm = @"SUBSCRIPTION_TIER_NOTEBOOK_LM"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierSearch = @"SUBSCRIPTION_TIER_SEARCH"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant = @"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierUnspecified = @"SUBSCRIPTION_TIER_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig.mode NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_Disabled = @"DISABLED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_Enabled = @"ENABLED"; @@ -956,6 +1077,7 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleted = @"DELETED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_DeleteFailed = @"DELETE_FAILED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleting = @"DELETING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Expired = @"EXPIRED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_KeyIssue = @"KEY_ISSUE"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Unusable = @"UNUSABLE"; @@ -996,6 +1118,80 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingFailed = @"TRAINING_FAILED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingPaused = @"TRAINING_PAUSED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.actionState +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Active = @"ACTIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Creating = @"CREATING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Failed = @"FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_InitializationFailed = @"INITIALIZATION_FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Running = @"RUNNING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Updating = @"UPDATING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Warning = @"WARNING"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.blockingReasons +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_AllowlistInServiceAttachment = @"ALLOWLIST_IN_SERVICE_ATTACHMENT"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_AllowlistServiceAccount = @"ALLOWLIST_SERVICE_ACCOUNT"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_AllowlistStaticIp = @"ALLOWLIST_STATIC_IP"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_BlockingReasonUnspecified = @"BLOCKING_REASON_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.connectorModes +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_Actions = @"ACTIONS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_ConnectorModeUnspecified = @"CONNECTOR_MODE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_DataIngestion = @"DATA_INGESTION"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_Eua = @"EUA"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_Federated = @"FEDERATED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_FederatedAndEua = @"FEDERATED_AND_EUA"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.connectorType +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_BigQuery = @"BIG_QUERY"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ConnectorTypeUnspecified = @"CONNECTOR_TYPE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_Gcnv = @"GCNV"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GcpFhir = @"GCP_FHIR"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_Gcs = @"GCS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleCalendar = @"GOOGLE_CALENDAR"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleDrive = @"GOOGLE_DRIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleMail = @"GOOGLE_MAIL"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_NativeCloudIdentity = @"NATIVE_CLOUD_IDENTITY"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdParty = @"THIRD_PARTY"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdPartyEua = @"THIRD_PARTY_EUA"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdPartyFederated = @"THIRD_PARTY_FEDERATED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.realtimeState +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Active = @"ACTIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Creating = @"CREATING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Failed = @"FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_InitializationFailed = @"INITIALIZATION_FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Running = @"RUNNING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Updating = @"UPDATING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Warning = @"WARNING"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.state +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Active = @"ACTIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Creating = @"CREATING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Failed = @"FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_InitializationFailed = @"INITIALIZATION_FAILED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Running = @"RUNNING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Updating = @"UPDATING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Warning = @"WARNING"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.syncMode +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Periodic = @"PERIODIC"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Streaming = @"STREAMING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Unspecified = @"UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError.streamingErrorReason +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_IngressEndpointRequired = @"INGRESS_ENDPOINT_REQUIRED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingErrorReasonUnspecified = @"STREAMING_ERROR_REASON_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSetupError = @"STREAMING_SETUP_ERROR"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError = @"STREAMING_SYNC_ERROR"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.configurableBillingApproach +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified = @"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding = @"CONFIGURABLE_CONSUMPTION_EMBEDDING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore = @"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.contentConfig NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_ContentConfigUnspecified = @"CONTENT_CONFIG_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_ContentRequired = @"CONTENT_REQUIRED"; @@ -1020,6 +1216,10 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_AppType_AppTypeIntranet = @"APP_TYPE_INTRANET"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_AppType_AppTypeUnspecified = @"APP_TYPE_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.configurableBillingApproach +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled = @"CONFIGURABLE_BILLING_APPROACH_ENABLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified = @"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.industryVertical NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_Generic = @"GENERIC"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_HealthcareFhir = @"HEALTHCARE_FHIR"; @@ -1062,6 +1262,32 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_Incremental = @"INCREMENTAL"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_ReconciliationModeUnspecified = @"RECONCILIATION_MODE_UNSPECIFIED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig.state +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_Active = @"ACTIVE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_Expired = @"EXPIRED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_NotStarted = @"NOT_STARTED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_StateUnspecified = @"STATE_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig.subscriptionTerm +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth = @"SUBSCRIPTION_TERM_ONE_MONTH"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermOneYear = @"SUBSCRIPTION_TERM_ONE_YEAR"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears = @"SUBSCRIPTION_TERM_THREE_YEARS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified = @"SUBSCRIPTION_TERM_UNSPECIFIED"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig.subscriptionTier +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness = @"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter = @"SUBSCRIPTION_TIER_AGENTSPACE_STARTER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEdu = @"SUBSCRIPTION_TIER_EDU"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging = @"SUBSCRIPTION_TIER_EDU_EMERGING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduPro = @"SUBSCRIPTION_TIER_EDU_PRO"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging = @"SUBSCRIPTION_TIER_EDU_PRO_EMERGING"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEnterprise = @"SUBSCRIPTION_TIER_ENTERPRISE"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker = @"SUBSCRIPTION_TIER_FRONTLINE_WORKER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm = @"SUBSCRIPTION_TIER_NOTEBOOK_LM"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierSearch = @"SUBSCRIPTION_TIER_SEARCH"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant = @"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierUnspecified = @"SUBSCRIPTION_TIER_UNSPECIFIED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms.state NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsAccepted = @"TERMS_ACCEPTED"; @@ -1123,6 +1349,16 @@ NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled = @"MATCH_HIGHLIGHTING_DISABLED"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled = @"MATCH_HIGHLIGHTING_ENABLED"; +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec.extractedFilterBehavior +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified = @"EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter = @"HARD_FILTER"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost = @"SOFT_BOOST"; + +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec.filterExtractionCondition +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified = @"CONDITION_UNSPECIFIED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled = @"DISABLED"; +NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled = @"ENABLED"; + // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec.condition NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_Auto = @"AUTO"; NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_ConditionUnspecified = @"CONDITION_UNSPECIFIED"; @@ -1701,6 +1937,31 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AclConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig +@dynamic actionParams, isActionConfigured, jsonActionParams, serviceName, + useStaticSecrets; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig_ActionParams +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig_ActionParams + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest @@ -1843,6 +2104,77 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedSiteSear @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfig +@dynamic alertEnrollments, alertPolicyName; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"alertEnrollments" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment +@dynamic alertId, enrollState; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig +@dynamic alertEnrollments, alertPolicy, contactDetails, languageCode; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"alertEnrollments" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment class], + @"contactDetails" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ContactDetails class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment +@dynamic alertId, enrollState, notificationParams; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_NotificationParams +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_NotificationParams + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlloyDbSource @@ -1869,7 +2201,8 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAclConfig // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig -@dynamic actionParams, isActionConfigured, serviceName, useStaticSecrets; +@dynamic actionParams, isActionConfigured, jsonActionParams, serviceName, + useStaticSecrets; @end @@ -1925,6 +2258,49 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicy @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig +@dynamic alertEnrollments, alertPolicy, contactDetails, languageCode; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"alertEnrollments" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment class], + @"contactDetails" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaContactDetails class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment +@dynamic alertId, enrollState, notificationParams; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_NotificationParams +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_NotificationParams + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer @@ -2289,15 +2665,17 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepA // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig -@dynamic supportedConnectorModes; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer +@dynamic assistSkippedReasons, customerPolicyEnforcementResult, name, replies, + state; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"supportedConnectorModes" : [NSString class] + @"assistSkippedReasons" : [NSString class], + @"replies" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerReply class] }; return map; } @@ -2307,25 +2685,33 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata -@dynamic createTime, updateTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult +@dynamic policyResults, verdict; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"policyResults" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult class] + }; + return map; +} + @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse -@dynamic targetSites; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult +@dynamic bannedPhrases; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"targetSites" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite class] + @"bannedPhrases" : [NSString class] }; return map; } @@ -2335,114 +2721,107 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreate // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata -@dynamic createTime, failureCount, successCount, updateTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult +@dynamic error, modelArmorViolation; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse -@dynamic errorSamples, userLicenses; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"errorSamples" : [GTLRDiscoveryEngine_GoogleRpcStatus class], - @"userLicenses" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserLicense class] - }; - return map; -} - +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult +@dynamic bannedPhraseEnforcementResult, modelArmorEnforcementResult; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerReply // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig -@dynamic isDefault, kmsKey, kmsKeyVersion, lastRotationTimestampMicros, name, - notebooklmState, singleRegionKeys, state; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerReply +@dynamic groundedContent, replyId; +@end -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"singleRegionKeys" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSingleRegionKey class] - }; - return map; -} +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContent +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContent +@dynamic codeExecutionResult, executableCode, file, inlineData, role, text, + thought; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCollection +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentBlob // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCollection -@dynamic createTime, dataConnector, displayName, name; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentBlob +@dynamic data, mimeType; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition -@dynamic activeTimeRange, queryRegex, queryTerms; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult +@dynamic outcome, output; +@end -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"activeTimeRange" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange class], - @"queryTerms" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm class] - }; - return map; -} +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode +@dynamic code; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentFile // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm -@dynamic fullMatch, value; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentFile +@dynamic fileId, mimeType; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange -@dynamic endTime, startTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent +@dynamic content, textGroundingMetadata; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun -@dynamic endTime, entityRuns, errors, latestPauseTime, name, startTime, state, - stateUpdateTime, trigger; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata +@dynamic references, segments; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"entityRuns" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun class], - @"errors" : [GTLRDiscoveryEngine_GoogleRpcStatus class] + @"references" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference class], + @"segments" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment class] }; return map; } @@ -2452,54 +2831,35 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRu // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun -@dynamic deletedRecordCount, entityNameProperty, errorRecordCount, errors, - extractedRecordCount, indexedRecordCount, progress, - scheduledRecordCount, sourceApiRequestCount, state, stateUpdateTime, - statsUpdateTime, syncType; - -+ (NSDictionary *)propertyToJSONKeyMap { - return @{ @"entityNameProperty" : @"entityName" }; -} - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"errors" : [GTLRDiscoveryEngine_GoogleRpcStatus class] - }; - return map; -} - +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference +@dynamic content, documentMetadata; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress -@dynamic currentCount, percentile, totalCount; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata +@dynamic document, domain, mimeType, pageIdentifier, title, uri; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl -@dynamic associatedServingConfigIds, boostAction, conditions, displayName, - filterAction, name, promoteAction, redirectAction, solutionType, - synonymsAction, useCases; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment +@dynamic endIndex, groundingScore, referenceIndices, startIndex, text; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"associatedServingConfigIds" : [NSString class], - @"conditions" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition class], - @"useCases" : [NSString class] + @"referenceIndices" : [NSNumber class] }; return map; } @@ -2509,12 +2869,243 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction -@dynamic boost, dataStore, filter, fixedBoost, interpolationBoostSpec; -@end +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig +@dynamic enabledActions, supportedConnectorModes; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"enabledActions" : [NSString class], + @"supportedConnectorModes" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata +@dynamic createTime, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse +@dynamic targetSites; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"targetSites" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata +@dynamic createTime, failureCount, successCount, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse +@dynamic errorSamples, userLicenses; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"errorSamples" : [GTLRDiscoveryEngine_GoogleRpcStatus class], + @"userLicenses" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserLicense class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig +@dynamic isDefault, kmsKey, kmsKeyVersion, lastRotationTimestampMicros, name, + notebooklmState, singleRegionKeys, state; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"singleRegionKeys" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSingleRegionKey class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCollection +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCollection +@dynamic createTime, dataConnector, displayName, name; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition +@dynamic activeTimeRange, queryRegex, queryTerms; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"activeTimeRange" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange class], + @"queryTerms" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm +@dynamic fullMatch, value; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange +@dynamic endTime, startTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun +@dynamic endTime, entityRuns, errors, latestPauseTime, name, startTime, state, + stateUpdateTime, trigger; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"entityRuns" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun class], + @"errors" : [GTLRDiscoveryEngine_GoogleRpcStatus class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun +@dynamic deletedRecordCount, entityNameProperty, errorRecordCount, errors, + extractedRecordCount, indexedRecordCount, progress, + scheduledRecordCount, sourceApiRequestCount, state, stateUpdateTime, + statsUpdateTime, syncType; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"entityNameProperty" : @"entityName" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"errors" : [GTLRDiscoveryEngine_GoogleRpcStatus class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress +@dynamic currentCount, percentile, totalCount; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaContactDetails +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaContactDetails +@dynamic emailAddress; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl +@dynamic associatedServingConfigIds, boostAction, conditions, displayName, + filterAction, name, promoteAction, redirectAction, solutionType, + synonymsAction, useCases; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"associatedServingConfigIds" : [NSString class], + @"conditions" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition class], + @"useCases" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction +@dynamic boost, dataStore, filter, fixedBoost, interpolationBoostSpec; +@end // ---------------------------------------------------------------------------- @@ -2684,10 +3275,11 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnect destinationConfigs, endUserConfig, entities, errors, federatedConfig, hybridIngestionDisabled, identityRefreshInterval, identityScheduleConfig, incrementalRefreshInterval, - incrementalSyncDisabled, kmsKeyName, lastSyncTime, latestPauseTime, - name, nextSyncTime, params, privateConnectivityProjectId, - realtimeState, realtimeSyncConfig, refreshInterval, removeParamKeys, - state, staticIpAddresses, staticIpEnabled, syncMode, updateTime; + incrementalSyncDisabled, jsonParams, kmsKeyName, lastSyncTime, + latestPauseTime, name, nextSyncTime, params, + privateConnectivityProjectId, realtimeState, realtimeSyncConfig, + refreshInterval, removeParamKeys, state, staticIpAddresses, + staticIpEnabled, syncMode, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -2726,7 +3318,7 @@ + (Class)classForAdditionalProperties { // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig -@dynamic additionalParams, authParams, tenant; +@dynamic additionalParams, authParams, jsonAuthParams, tenant; @end @@ -2764,7 +3356,7 @@ + (Class)classForAdditionalProperties { // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig -@dynamic additionalParams, authParams; +@dynamic additionalParams, authParams, jsonAuthParams; @end @@ -2822,7 +3414,7 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnect // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity -@dynamic dataStore, entityNameProperty, healthcareFhirConfig, +@dynamic dataStore, entityNameProperty, healthcareFhirConfig, jsonParams, keyPropertyMappings, params, startingSchema; + (NSDictionary *)propertyToJSONKeyMap { @@ -2867,11 +3459,12 @@ + (Class)classForAdditionalProperties { @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore @dynamic aclEnabled, advancedSiteSearchConfig, billingEstimation, cmekConfig, - contentConfig, createTime, defaultSchemaId, displayName, - documentProcessingConfig, healthcareFhirConfig, identityMappingStore, - idpConfig, industryVertical, isInfobotFaqDataStore, kmsKeyName, - languageInfo, name, naturalLanguageQueryUnderstandingConfig, - servingConfigDataStore, solutionTypes, startingSchema, workspaceConfig; + configurableBillingApproach, contentConfig, createTime, + defaultSchemaId, displayName, documentProcessingConfig, + healthcareFhirConfig, identityMappingStore, idpConfig, + industryVertical, isInfobotFaqDataStore, kmsKeyName, languageInfo, + name, naturalLanguageQueryUnderstandingConfig, servingConfigDataStore, + solutionTypes, startingSchema, workspaceConfig; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -3011,7 +3604,7 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteTarge // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig -@dynamic destinations, key, params; +@dynamic destinations, jsonParams, key, params; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -3196,10 +3789,10 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEnableAdvan @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine @dynamic appType, chatEngineConfig, chatEngineMetadata, commonConfig, - createTime, dataStoreIds, disableAnalytics, displayName, features, - industryVertical, mediaRecommendationEngineConfig, name, - recommendationMetadata, searchEngineConfig, similarDocumentsConfig, - solutionType, updateTime; + configurableBillingApproach, createTime, dataStoreIds, + disableAnalytics, displayName, features, industryVertical, + mediaRecommendationEngineConfig, name, recommendationMetadata, + searchEngineConfig, similarDocumentsConfig, solutionType, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -3739,6 +4332,17 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLanguageInf @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig +@dynamic alertPolicyResourceConfig, autoRenew, endDate, freeTrial, licenseCount, + name, startDate, state, subscriptionTerm, subscriptionTier; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaListSessionsRequest @@ -3807,7 +4411,8 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaOrganicCraw // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject -@dynamic createTime, name, provisionCompletionTime, serviceTermsMap; +@dynamic createTime, customerProvidedConfig, name, provisionCompletionTime, + serviceTermsMap; @end @@ -3825,6 +4430,36 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig +@dynamic notebooklmConfig; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig +@dynamic modelArmorConfig; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig +@dynamic responseTemplate, userPromptTemplate; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms @@ -4144,8 +4779,9 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchReque pageSize, pageToken, params, personalizationSpec, query, queryExpansionSpec, rankingExpression, rankingExpressionBackend, regionCode, relevanceScoreSpec, relevanceThreshold, safeSearch, - searchAsYouTypeSpec, servingConfig, session, sessionSpec, - spellCorrectionSpec, useLatestData, userInfo, userLabels, userPseudoId; + searchAddonSpec, searchAsYouTypeSpec, servingConfig, session, + sessionSpec, spellCorrectionSpec, useLatestData, userInfo, userLabels, + userPseudoId; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -4439,11 +5075,12 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchReque // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec -@dynamic extractedFilterBehavior, filterExtractionCondition, +@dynamic allowedFieldNames, extractedFilterBehavior, filterExtractionCondition, geoSearchQueryDetectionFieldNames; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"allowedFieldNames" : [NSString class], @"geoSearchQueryDetectionFieldNames" : [NSString class] }; return map; @@ -4482,6 +5119,17 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchReque @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec +@dynamic disableGenerativeAnswerAddOn, disableKpiPersonalizationAddOn, + disableSemanticAddOn; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec @@ -4537,7 +5185,7 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn -@dynamic answer, detailedAnswer, query, queryConfig; +@dynamic answer, detailedAnswer, detailedAssistAnswer, query, queryConfig; @end @@ -5771,7 +6419,7 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantGrounde // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata -@dynamic document, domain, pageIdentifier, title, uri; +@dynamic document, domain, mimeType, pageIdentifier, title, uri; @end @@ -5831,6 +6479,25 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistUserMetada @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig +@dynamic enabledActions, supportedConnectorModes; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"enabledActions" : [NSString class], + @"supportedConnectorModes" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata @@ -5955,16 +6622,64 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserL // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse +@dynamic errorSamples, userLicenses; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"errorSamples" : [GTLRDiscoveryEngine_GoogleRpcStatus class], + @"userLicenses" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAclConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAclConfig +@dynamic idpConfig, name; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig +@dynamic disableAutomaticRefresh, disableInitialIndex; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse -@dynamic errorSamples, userLicenses; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig +@dynamic alertEnrollments, alertPolicy, contactDetails, languageCode; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"errorSamples" : [GTLRDiscoveryEngine_GoogleRpcStatus class], - @"userLicenses" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense class] + @"alertEnrollments" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment class], + @"contactDetails" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaContactDetails class] }; return map; } @@ -5974,30 +6689,25 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserL // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment +@dynamic alertId, enrollState, notificationParams; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAclConfig +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_NotificationParams // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAclConfig -@dynamic idpConfig, name; -@end - +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_NotificationParams -// ---------------------------------------------------------------------------- -// -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig -// ++ (Class)classForAdditionalProperties { + return [NSString class]; +} -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig -@dynamic disableAutomaticRefresh, disableInitialIndex; @end @@ -6116,6 +6826,16 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionTim @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaContactDetails +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaContactDetails +@dynamic emailAddress; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl @@ -6300,10 +7020,11 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateTarget @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore @dynamic aclEnabled, advancedSiteSearchConfig, billingEstimation, cmekConfig, - contentConfig, createTime, defaultSchemaId, displayName, - documentProcessingConfig, healthcareFhirConfig, identityMappingStore, - industryVertical, isInfobotFaqDataStore, kmsKeyName, languageInfo, - name, naturalLanguageQueryUnderstandingConfig, servingConfigDataStore, + configurableBillingApproach, contentConfig, createTime, + defaultSchemaId, displayName, documentProcessingConfig, + healthcareFhirConfig, identityMappingStore, industryVertical, + isInfobotFaqDataStore, kmsKeyName, languageInfo, name, + naturalLanguageQueryUnderstandingConfig, servingConfigDataStore, solutionTypes, startingSchema, workspaceConfig; + (NSDictionary *)arrayPropertyToClassMap { @@ -6557,9 +7278,10 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEnableAdvanc @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine @dynamic appType, chatEngineConfig, chatEngineMetadata, commonConfig, - createTime, dataStoreIds, disableAnalytics, displayName, features, - industryVertical, mediaRecommendationEngineConfig, name, - searchEngineConfig, solutionType, updateTime; + configurableBillingApproach, createTime, dataStoreIds, + disableAnalytics, displayName, features, industryVertical, + mediaRecommendationEngineConfig, name, searchEngineConfig, + solutionType, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -6961,6 +7683,17 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLanguageInfo @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig +@dynamic alertPolicyResourceConfig, autoRenew, endDate, freeTrial, licenseCount, + name, startDate, state, subscriptionTerm, subscriptionTier; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig @@ -6997,7 +7730,8 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaOrganicCrawl // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject -@dynamic createTime, name, provisionCompletionTime, serviceTermsMap; +@dynamic createTime, customerProvidedConfig, name, provisionCompletionTime, + serviceTermsMap; @end @@ -7015,6 +7749,36 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig +@dynamic notebooklmConfig; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig +@dynamic modelArmorConfig; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig +@dynamic responseTemplate, userPromptTemplate; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms @@ -7186,9 +7950,9 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchReques oneBoxPageSize, orderBy, pageSize, pageToken, params, personalizationSpec, query, queryExpansionSpec, rankingExpression, rankingExpressionBackend, regionCode, relevanceScoreSpec, - relevanceThreshold, safeSearch, searchAsYouTypeSpec, servingConfig, - session, sessionSpec, spellCorrectionSpec, userInfo, userLabels, - userPseudoId; + relevanceThreshold, safeSearch, searchAddonSpec, searchAsYouTypeSpec, + servingConfig, session, sessionSpec, spellCorrectionSpec, userInfo, + userLabels, userPseudoId; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -7482,11 +8246,12 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchReques // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec -@dynamic extractedFilterBehavior, filterExtractionCondition, +@dynamic allowedFieldNames, extractedFilterBehavior, filterExtractionCondition, geoSearchQueryDetectionFieldNames; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"allowedFieldNames" : [NSString class], @"geoSearchQueryDetectionFieldNames" : [NSString class] }; return map; @@ -7525,6 +8290,17 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchReques @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec +@dynamic disableGenerativeAnswerAddOn, disableKpiPersonalizationAddOn, + disableSemanticAddOn; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec @@ -8056,6 +8832,16 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Collection +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Collection +@dynamic createTime, displayName, name; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompleteQueryResponse @@ -8160,6 +8946,16 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionTimeRan @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ContactDetails +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ContactDetails +@dynamic emailAddress; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control @@ -8252,15 +9048,183 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlRedirectA // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction +@dynamic synonyms; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"synonyms" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation +@dynamic endTime, messages, name, startTime, state, userPseudoId; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"messages" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationContext +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationContext +@dynamic activeDocument, contextDocuments; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"contextDocuments" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage +@dynamic createTime, reply, userInput; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest +@dynamic boostSpec, conversation, filter, query, safeSearch, servingConfig, + summarySpec, userLabels; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationResponse +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationResponse +@dynamic conversation, reply, searchResults; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"searchResults" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSearchResult class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateDataStoreMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateDataStoreMetadata +@dynamic createTime, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateEngineMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateEngineMetadata +@dynamic createTime, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSchemaMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSchemaMetadata +@dynamic createTime, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSitemapMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSitemapMetadata +@dynamic createTime, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata +@dynamic createTime, updateTime; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteRequest +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteRequest +@dynamic parent, targetSite; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction -@dynamic synonyms; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute +@dynamic numbers, text; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"synonyms" : [NSString class] + @"numbers" : [NSNumber class], + @"text" : [NSString class] }; return map; } @@ -8270,17 +9234,24 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsA // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation -@dynamic endTime, messages, name, startTime, state, userPseudoId; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel +@dynamic createTime, displayName, errorMessage, metrics, modelState, + modelVersion, name, trainingStartTime; +@end -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"messages" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage class] - }; - return map; + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics + ++ (Class)classForAdditionalProperties { + return [NSNumber class]; } @end @@ -8288,15 +9259,32 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationContext +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationContext -@dynamic activeDocument, contextDocuments; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector +@dynamic aclEnabled, actionConfig, actionState, alertPolicyConfigs, + autoRunDisabled, bapConfig, blockingReasons, connectorModes, + connectorType, createEuaSaas, createTime, dataSource, + destinationConfigs, endUserConfig, entities, errors, federatedConfig, + hybridIngestionDisabled, identityRefreshInterval, + identityScheduleConfig, incrementalRefreshInterval, + incrementalSyncDisabled, jsonParams, kmsKeyName, lastSyncTime, + latestPauseTime, name, nextSyncTime, params, + privateConnectivityProjectId, realtimeState, realtimeSyncConfig, + refreshInterval, removeParamKeys, state, staticIpAddresses, + staticIpEnabled, syncMode, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"contextDocuments" : [NSString class] + @"alertPolicyConfigs" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfig class], + @"blockingReasons" : [NSString class], + @"connectorModes" : [NSString class], + @"destinationConfigs" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig class], + @"entities" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity class], + @"errors" : [GTLRDiscoveryEngine_GoogleRpcStatus class], + @"removeParamKeys" : [NSString class], + @"staticIpAddresses" : [NSString class] }; return map; } @@ -8306,34 +9294,37 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationCont // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_Params // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage -@dynamic createTime, reply, userInput; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_Params + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest -@dynamic boostSpec, conversation, filter, query, safeSearch, servingConfig, - summarySpec, userLabels; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig +@dynamic additionalParams, authParams, jsonAuthParams, tenant; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AdditionalParams // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AdditionalParams + (Class)classForAdditionalProperties { - return [NSString class]; + return [NSObject class]; } @end @@ -8341,17 +9332,13 @@ + (Class)classForAdditionalProperties { // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationResponse +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AuthParams // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationResponse -@dynamic conversation, reply, searchResults; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AuthParams -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"searchResults" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSearchResult class] - }; - return map; ++ (Class)classForAdditionalProperties { + return [NSObject class]; } @end @@ -8359,78 +9346,73 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversa // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateDataStoreMetadata +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateDataStoreMetadata -@dynamic createTime, updateTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig +@dynamic additionalParams, authParams, jsonAuthParams; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateEngineMetadata +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AdditionalParams // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateEngineMetadata -@dynamic createTime, updateTime; -@end - +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AdditionalParams -// ---------------------------------------------------------------------------- -// -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSchemaMetadata -// ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSchemaMetadata -@dynamic createTime, updateTime; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSitemapMetadata +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AuthParams // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSitemapMetadata -@dynamic createTime, updateTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AuthParams + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata -@dynamic createTime, updateTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig +@dynamic realtimeSyncSecret, streamingError, webhookUri; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteRequest +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteRequest -@dynamic parent, targetSite; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError +@dynamic error, streamingErrorReason; @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute -@dynamic numbers, text; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity +@dynamic dataStore, entityNameProperty, healthcareFhirConfig, jsonParams, + keyPropertyMappings, params, startingSchema; -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"numbers" : [NSNumber class], - @"text" : [NSString class] - }; - return map; ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"entityNameProperty" : @"entityName" }; } @end @@ -8438,24 +9420,27 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_KeyPropertyMappings // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel -@dynamic createTime, displayName, errorMessage, metrics, modelState, - modelVersion, name, trainingStartTime; +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_KeyPropertyMappings + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + @end // ---------------------------------------------------------------------------- // -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_Params // -@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_Params + (Class)classForAdditionalProperties { - return [NSNumber class]; + return [NSObject class]; } @end @@ -8468,10 +9453,11 @@ + (Class)classForAdditionalProperties { @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore @dynamic aclEnabled, advancedSiteSearchConfig, billingEstimation, cmekConfig, - contentConfig, createTime, defaultSchemaId, displayName, - documentProcessingConfig, healthcareFhirConfig, identityMappingStore, - industryVertical, isInfobotFaqDataStore, kmsKeyName, name, - servingConfigDataStore, solutionTypes, startingSchema, workspaceConfig; + configurableBillingApproach, contentConfig, createTime, + defaultSchemaId, displayName, documentProcessingConfig, + healthcareFhirConfig, identityMappingStore, industryVertical, + isInfobotFaqDataStore, kmsKeyName, name, servingConfigDataStore, + solutionTypes, startingSchema, workspaceConfig; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -8514,6 +9500,16 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteCmekConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteCollectionMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteCollectionMetadata +@dynamic createTime, updateTime; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata @@ -8574,6 +9570,48 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteTargetSite @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig +@dynamic destinations, jsonParams, key, params; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"destinations" : [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfigDestination class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig_Params +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig_Params + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfigDestination +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfigDestination +@dynamic host, port; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata @@ -8889,9 +9927,10 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EnableAdvancedSi @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine @dynamic appType, chatEngineConfig, chatEngineMetadata, commonConfig, - createTime, dataStoreIds, disableAnalytics, displayName, features, - industryVertical, mediaRecommendationEngineConfig, name, - searchEngineConfig, solutionType, updateTime; + configurableBillingApproach, createTime, dataStoreIds, + disableAnalytics, displayName, features, industryVertical, + mediaRecommendationEngineConfig, name, searchEngineConfig, + solutionType, updateTime; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -9211,6 +10250,16 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityMappingS @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityScheduleConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityScheduleConfig +@dynamic nextSyncTime, refreshInterval; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig @@ -9524,6 +10573,17 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Interval @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig +@dynamic alertPolicyResourceConfig, autoRenew, endDate, freeTrial, licenseCount, + name, startDate, state, subscriptionTerm, subscriptionTier; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ListCmekConfigsResponse @@ -9856,7 +10916,8 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Principal // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Project -@dynamic createTime, name, provisionCompletionTime, serviceTermsMap; +@dynamic createTime, customerProvidedConfig, name, provisionCompletionTime, + serviceTermsMap; @end @@ -9874,6 +10935,36 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig +@dynamic notebooklmConfig; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig +@dynamic modelArmorConfig; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig +@dynamic responseTemplate, userPromptTemplate; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms @@ -9914,7 +11005,7 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProvisionProject // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams -@dynamic acceptBizQos; +@dynamic acceptBizQos, isBiz; @end @@ -10352,12 +11443,12 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchLinkPromot @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest @dynamic boostSpec, branch, canonicalFilter, contentSearchSpec, dataStoreSpecs, - displaySpec, facetSpecs, filter, imageQuery, languageCode, offset, - oneBoxPageSize, orderBy, pageSize, pageToken, params, query, - queryExpansionSpec, rankingExpression, rankingExpressionBackend, - relevanceScoreSpec, relevanceThreshold, safeSearch, - searchAsYouTypeSpec, session, sessionSpec, spellCorrectionSpec, - userInfo, userLabels, userPseudoId; + displaySpec, facetSpecs, filter, imageQuery, languageCode, + naturalLanguageQueryUnderstandingSpec, offset, oneBoxPageSize, orderBy, + pageSize, pageToken, params, query, queryExpansionSpec, + rankingExpression, rankingExpressionBackend, relevanceScoreSpec, + relevanceThreshold, safeSearch, searchAsYouTypeSpec, session, + sessionSpec, spellCorrectionSpec, userInfo, userLabels, userPseudoId; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -10599,6 +11690,26 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestIma @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec +@dynamic allowedFieldNames, extractedFilterBehavior, filterExtractionCondition, + geoSearchQueryDetectionFieldNames; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"allowedFieldNames" : [NSString class], + @"geoSearchQueryDetectionFieldNames" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec @@ -10985,7 +12096,7 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session // @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SessionTurn -@dynamic answer, detailedAnswer, query, queryConfig; +@dynamic answer, detailedAnswer, detailedAssistAnswer, query, queryConfig; @end @@ -11003,6 +12114,25 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest +@dynamic collectionDisplayName, collectionId, dataConnector; +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SingleRegionKey @@ -11191,6 +12321,21 @@ @implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSiteFailur @end +// ---------------------------------------------------------------------------- +// +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Tenant +// + +@implementation GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Tenant +@dynamic displayName, identifier, uri; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"identifier" : @"id" }; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TextInput @@ -11388,11 +12533,12 @@ @implementation GTLRDiscoveryEngine_GoogleLongrunningCancelOperationRequest // @implementation GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRDiscoveryEngine_GoogleLongrunningOperation class] + @"operations" : [GTLRDiscoveryEngine_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineQuery.m b/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineQuery.m index 8004e1196..6fa673c53 100644 --- a/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineQuery.m +++ b/Sources/GeneratedServices/DiscoveryEngine/GTLRDiscoveryEngineQuery.m @@ -149,7 +149,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataConnectorOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -414,7 +414,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataStoresBranchesOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -924,7 +924,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataStoresModelsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -962,7 +962,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataStoresOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -1111,7 +1111,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataStoresSchemasOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -1568,7 +1568,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -1820,7 +1820,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -2045,6 +2045,25 @@ + (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV @end +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDelete + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleLongrunningOperation class]; + query.loggingName = @"discoveryengine.projects.locations.collections.delete"; + return query; +} + +@end + @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsEnginesAssistantsGet @dynamic name; @@ -2526,7 +2545,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsEnginesOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -2862,6 +2881,25 @@ + (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV @end +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsGetDataConnector + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsGetDataConnector *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector class]; + query.loggingName = @"discoveryengine.projects.locations.collections.getDataConnector"; + return query; +} + +@end + @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsOperationsGet @dynamic name; @@ -2883,7 +2921,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -2900,6 +2938,33 @@ + (instancetype)queryWithName:(NSString *)name { @end +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsUpdateDataConnector + +@dynamic name, updateMask; + ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsUpdateDataConnector *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector class]; + query.loggingName = @"discoveryengine.projects.locations.collections.updateDataConnector"; + return query; +} + +@end + @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsDataStoresBranchesBatchGetDocumentsMetadata @dynamic matcherFhirMatcherFhirResources, matcherUrisMatcherUris, parent; @@ -3148,7 +3213,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsDataStoresBranchesOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -3639,7 +3704,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsDataStoresModelsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -3677,7 +3742,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsDataStoresOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -4789,7 +4854,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsIdentityMappingStoresOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -4833,6 +4898,79 @@ + (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV @end +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsCreate + +@dynamic licenseConfigId, parent; + ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/licenseConfigs"; + GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsCreate *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig class]; + query.loggingName = @"discoveryengine.projects.locations.licenseConfigs.create"; + return query; +} + +@end + +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig class]; + query.loggingName = @"discoveryengine.projects.locations.licenseConfigs.get"; + return query; +} + +@end + +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsPatch + +@dynamic name, updateMask; + ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig class]; + query.loggingName = @"discoveryengine.projects.locations.licenseConfigs.patch"; + return query; +} + +@end + @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsOperationsGet @dynamic name; @@ -4854,7 +4992,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -4917,6 +5055,60 @@ + (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV @end +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnector + +@dynamic parent; + ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}:setUpDataConnector"; + GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnector *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleLongrunningOperation class]; + query.loggingName = @"discoveryengine.projects.locations.setUpDataConnector"; + return query; +} + +@end + +@implementation GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnectorV2 + +@dynamic collectionDisplayName, collectionId, parent; + ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}:setUpDataConnectorV2"; + GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnectorV2 *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLRDiscoveryEngine_GoogleLongrunningOperation class]; + query.loggingName = @"discoveryengine.projects.locations.setUpDataConnectorV2"; + return query; +} + +@end + @implementation GTLRDiscoveryEngineQuery_ProjectsLocationsUpdateAclConfig @dynamic name; @@ -5138,7 +5330,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDiscoveryEngineQuery_ProjectsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineObjects.h b/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineObjects.h index f1f4c5c09..89cd9c6b3 100644 --- a/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineObjects.h +++ b/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineObjects.h @@ -48,6 +48,8 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingImportErrorContext; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingServiceContext; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingSourceLocation; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig_ActionParams; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec; @@ -56,12 +58,20 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_NotificationParams; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlloyDbSource; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig_ActionParams; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_NotificationParams; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob; @@ -87,6 +97,22 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerReply; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContent; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentBlob; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentFile; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition; @@ -94,6 +120,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaContactDetails; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint; @@ -158,6 +185,9 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject_ServiceTermsMap; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetrics; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; @@ -194,6 +224,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; @@ -286,14 +317,19 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantToolInfo; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantToolList; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistUserMetadata; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_NotificationParams; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCondition; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionQueryTerm; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionTimeRange; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaContactDetails; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostAction; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint; @@ -335,6 +371,9 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject_ServiceTermsMap; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetrics; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; @@ -367,6 +406,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; @@ -405,6 +445,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Condition; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionQueryTerm; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionTimeRange; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ContactDetails; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostAction; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec; @@ -421,9 +462,25 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_Params; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AdditionalParams; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AuthParams; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AdditionalParams; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AuthParams; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_KeyPropertyMappings; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_Params; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStoreBillingEstimation; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig_Params; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfigDestination; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document_DerivedStructData; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document_StructData; @@ -464,6 +521,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1HealthcareFhirConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityMappingEntry; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityMappingStore; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityScheduleConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfigExternalIdpConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource; @@ -478,6 +536,9 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1PanelInfo; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Principal; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Project_ServiceTermsMap; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource; @@ -514,6 +575,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestFacetSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestImageQuery; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec; @@ -555,6 +617,7 @@ @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSiteFailureReason; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; +@class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Tenant; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TextInput; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput; @class GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TrainCustomModelResponse_Metrics; @@ -837,6 +900,52 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_ThirdPartyIdentity; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment.enrollState + +/** + * Customer declined this policy. + * + * Value: "DECLINED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_Declined; +/** + * Customer is enrolled in this policy. + * + * Value: "ENROLLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_Enrolled; +/** + * Default value. Used for customers who have not responded to the alert + * policy. + * + * Value: "ENROLL_STATES_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment.enrollState + +/** + * Customer declined this policy. + * + * Value: "DECLINED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined; +/** + * Customer is enrolled in this policy. + * + * Value: "ENROLLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled; +/** + * Default value. Used for customers who have not responded to the alert + * policy. + * + * Value: "ENROLL_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment.enrollState @@ -860,6 +969,29 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment.enrollState + +/** + * Customer declined this policy. + * + * Value: "DECLINED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined; +/** + * Customer is enrolled in this policy. + * + * Value: "ENROLLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled; +/** + * Default value. Used for customers who have not responded to the alert + * policy. + * + * Value: "ENROLL_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer.answerSkippedReasons @@ -1074,6 +1206,116 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_Succeeded; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer.assistSkippedReasons + +/** + * Default value. Skip reason is not specified. + * + * Value: "ASSIST_SKIPPED_REASON_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_AssistSkippedReasons_AssistSkippedReasonUnspecified; +/** + * The assistant ignored the query or refused to answer because of a customer + * policy violation (e.g., the query or the answer contained a banned phrase). + * + * Value: "CUSTOMER_POLICY_VIOLATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_AssistSkippedReasons_CustomerPolicyViolation; +/** + * The assistant ignored the query, because it did not appear to be + * answer-seeking. + * + * Value: "NON_ASSIST_SEEKING_QUERY_IGNORED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_AssistSkippedReasons_NonAssistSeekingQueryIgnored; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer.state + +/** + * Assist operation has failed. + * + * Value: "FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Failed; +/** + * Assist operation is currently in progress. + * + * Value: "IN_PROGRESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_InProgress; +/** + * Assist operation has been skipped. + * + * Value: "SKIPPED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Skipped; +/** + * Unknown. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_StateUnspecified; +/** + * Assist operation has succeeded. + * + * Value: "SUCCEEDED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Succeeded; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult.verdict + +/** + * There was no policy violation. + * + * Value: "ALLOW" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Allow; +/** + * Processing was blocked by the customer policy. + * + * Value: "BLOCK" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Block; +/** + * Unknown value. + * + * Value: "UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Unspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult.outcome + +/** + * Code execution ran for too long, and was cancelled. There may or may not be + * a partial output present. + * + * Value: "OUTCOME_DEADLINE_EXCEEDED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeDeadlineExceeded; +/** + * Code execution finished but with a failure. `stderr` should contain the + * reason. + * + * Value: "OUTCOME_FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeFailed; +/** + * Code execution completed successfully. + * + * Value: "OUTCOME_OK" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeOk; +/** + * Unspecified status. This value should not be used. + * + * Value: "OUTCOME_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig.supportedConnectorModes @@ -1169,6 +1411,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi * Value: "DELETING" */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleting; +/** + * The KMS key is expired, meaning the key has been disabled for 30+ days. The + * customer can call DeleteCmekConfig to change the state to DELETED. + * + * Value: "EXPIRED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Expired; /** * The CmekConfig is unavailable, most likely due to the KMS Key being revoked. * @@ -1846,6 +2095,29 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore.configurableBillingApproach + +/** + * Default value. For Spark and non-Spark non-configurable billing approach. + * + * Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified; +/** + * Use the consumption pay-as-you-go billing for embedding storage add-on. + * + * Value: "CONFIGURABLE_CONSUMPTION_EMBEDDING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding; +/** + * Use the subscription base + overage billing for indexing core for non + * embedding storage. + * + * Value: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore.contentConfig @@ -1962,6 +2234,23 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeUnspecified; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine.configurableBillingApproach + +/** + * The billing approach follows configurations specified by customer. + * + * Value: "CONFIGURABLE_BILLING_APPROACH_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled; +/** + * Default value. For Spark and non-Spark non-configurable billing approach. + * General pricing model. + * + * Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine.industryVertical @@ -2445,6 +2734,141 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_ThirdParty; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig.state + +/** + * The license config is effective and being used. + * + * Value: "ACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_Active; +/** + * The license config has expired. + * + * Value: "EXPIRED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_Expired; +/** + * The license config has not started yet, and its start date is in the future. + * + * Value: "NOT_STARTED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_NotStarted; +/** + * Default value. The license config does not exist. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_StateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig.subscriptionTerm + +/** + * 1 month. + * + * Value: "SUBSCRIPTION_TERM_ONE_MONTH" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth; +/** + * 1 year. + * + * Value: "SUBSCRIPTION_TERM_ONE_YEAR" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermOneYear; +/** + * 3 years. + * + * Value: "SUBSCRIPTION_TERM_THREE_YEARS" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears; +/** + * Default value, do not use. + * + * Value: "SUBSCRIPTION_TERM_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig.subscriptionTier + +/** + * Agentspace Business tier. + * + * Value: "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness; +/** + * Agentspace Starter tier. + * + * Value: "SUBSCRIPTION_TIER_AGENTSPACE_STARTER" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter; +/** + * EDU tier. + * + * Value: "SUBSCRIPTION_TIER_EDU" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEdu; +/** + * EDU emerging market tier. + * + * Value: "SUBSCRIPTION_TIER_EDU_EMERGING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging; +/** + * EDU Pro tier. + * + * Value: "SUBSCRIPTION_TIER_EDU_PRO" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduPro; +/** + * EDU Pro emerging market tier. + * + * Value: "SUBSCRIPTION_TIER_EDU_PRO_EMERGING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging; +/** + * Enterprise tier. + * + * Value: "SUBSCRIPTION_TIER_ENTERPRISE" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEnterprise; +/** + * Frontline worker tier. + * + * Value: "SUBSCRIPTION_TIER_FRONTLINE_WORKER" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker; +/** + * NotebookLM tier. NotebookLM is a subscription tier can only access + * NotebookLM features. + * + * Value: "SUBSCRIPTION_TIER_NOTEBOOK_LM" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm; +/** + * Search tier. Search tier can access VAIS search features and NotebookLM + * features. + * + * Value: "SUBSCRIPTION_TIER_SEARCH" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierSearch; +/** + * Search + assistant tier. Search + assistant tier can access VAIS search + * features, NotebookLM features and assistant features. + * + * Value: "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant; +/** + * Default value. + * + * Value: "SUBSCRIPTION_TIER_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig.mode @@ -3815,22 +4239,50 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig_FailureMode_FailureModeUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata.state +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig.supportedConnectorModes /** - * The Document is indexed. + * Connector utilized for Actions * - * Value: "INDEXED" + * Value: "ACTIONS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_Indexed; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_Actions; /** - * The Document is not indexed. + * Connector mode unspecified. * - * Value: "NOT_IN_INDEX" + * Value: "CONNECTOR_MODE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_NotInIndex; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_ConnectorModeUnspecified; /** - * The Document is not indexed because its URI is not in the TargetSite. + * Connector utilized for data ingestion. + * + * Value: "DATA_INGESTION" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_DataIngestion; +/** + * Connector utilized for End User Authentication. + * + * Value: "END_USER_AUTHENTICATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig_SupportedConnectorModes_EndUserAuthentication; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata.state + +/** + * The Document is indexed. + * + * Value: "INDEXED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_Indexed; +/** + * The Document is not indexed. + * + * Value: "NOT_IN_INDEX" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_NotInIndex; +/** + * The Document is not indexed because its URI is not in the TargetSite. * * Value: "NOT_IN_TARGET_SITE" */ @@ -3842,6 +4294,29 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata_State_StateUnspecified; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment.enrollState + +/** + * Customer declined this policy. + * + * Value: "DECLINED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined; +/** + * Customer is enrolled in this policy. + * + * Value: "ENROLLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled; +/** + * Default value. Used for customers who have not responded to the alert + * policy. + * + * Value: "ENROLL_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig.notebooklmState @@ -3909,6 +4384,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi * Value: "DELETING" */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleting; +/** + * The KMS key is expired, meaning the key has been disabled for 30+ days. The + * customer can call DeleteCmekConfig to change the state to DELETED. + * + * Value: "EXPIRED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Expired; /** * The CmekConfig is unavailable, most likely due to the KMS Key being revoked. * @@ -4031,6 +4513,29 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_Linear; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore.configurableBillingApproach + +/** + * Default value. For Spark and non-Spark non-configurable billing approach. + * + * Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified; +/** + * Use the consumption pay-as-you-go billing for embedding storage add-on. + * + * Value: "CONFIGURABLE_CONSUMPTION_EMBEDDING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding; +/** + * Use the subscription base + overage billing for indexing core for non + * embedding storage. + * + * Value: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore.contentConfig @@ -4147,6 +4652,23 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeUnspecified; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine.configurableBillingApproach + +/** + * The billing approach follows configurations specified by customer. + * + * Value: "CONFIGURABLE_BILLING_APPROACH_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled; +/** + * Default value. For Spark and non-Spark non-configurable billing approach. + * General pricing model. + * + * Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine.industryVertical @@ -4350,6 +4872,141 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_ThirdParty; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig.state + +/** + * The license config is effective and being used. + * + * Value: "ACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_Active; +/** + * The license config has expired. + * + * Value: "EXPIRED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_Expired; +/** + * The license config has not started yet, and its start date is in the future. + * + * Value: "NOT_STARTED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_NotStarted; +/** + * Default value. The license config does not exist. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_StateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig.subscriptionTerm + +/** + * 1 month. + * + * Value: "SUBSCRIPTION_TERM_ONE_MONTH" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth; +/** + * 1 year. + * + * Value: "SUBSCRIPTION_TERM_ONE_YEAR" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermOneYear; +/** + * 3 years. + * + * Value: "SUBSCRIPTION_TERM_THREE_YEARS" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears; +/** + * Default value, do not use. + * + * Value: "SUBSCRIPTION_TERM_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig.subscriptionTier + +/** + * Agentspace Business tier. + * + * Value: "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness; +/** + * Agentspace Starter tier. + * + * Value: "SUBSCRIPTION_TIER_AGENTSPACE_STARTER" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter; +/** + * EDU tier. + * + * Value: "SUBSCRIPTION_TIER_EDU" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEdu; +/** + * EDU emerging market tier. + * + * Value: "SUBSCRIPTION_TIER_EDU_EMERGING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging; +/** + * EDU Pro tier. + * + * Value: "SUBSCRIPTION_TIER_EDU_PRO" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduPro; +/** + * EDU Pro emerging market tier. + * + * Value: "SUBSCRIPTION_TIER_EDU_PRO_EMERGING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging; +/** + * Enterprise tier. + * + * Value: "SUBSCRIPTION_TIER_ENTERPRISE" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEnterprise; +/** + * Frontline worker tier. + * + * Value: "SUBSCRIPTION_TIER_FRONTLINE_WORKER" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker; +/** + * NotebookLM tier. NotebookLM is a subscription tier can only access + * NotebookLM features. + * + * Value: "SUBSCRIPTION_TIER_NOTEBOOK_LM" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm; +/** + * Search tier. Search tier can access VAIS search features and NotebookLM + * features. + * + * Value: "SUBSCRIPTION_TIER_SEARCH" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierSearch; +/** + * Search + assistant tier. Search + assistant tier can access VAIS search + * features, NotebookLM features and assistant features. + * + * Value: "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant; +/** + * Default value. + * + * Value: "SUBSCRIPTION_TIER_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierUnspecified; + // ---------------------------------------------------------------------------- // GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig.mode @@ -5252,6 +5909,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi * Value: "DELETING" */ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleting; +/** + * The KMS key is expired, meaning the key has been disabled for 30+ days. The + * customer can call DeleteCmekConfig to change the state to DELETED. + * + * Value: "EXPIRED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Expired; /** * The CmekConfig is unavailable, most likely due to the KMS Key being revoked. * @@ -5449,5864 +6113,5636 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengi FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingPaused; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.contentConfig +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.actionState /** - * Default value. + * The connector is successfully set up and awaiting next sync run. * - * Value: "CONTENT_CONFIG_UNSPECIFIED" + * Value: "ACTIVE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_ContentConfigUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Active; /** - * Only contains documents with Document.content. + * The connector is being set up. * - * Value: "CONTENT_REQUIRED" + * Value: "CREATING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_ContentRequired; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Creating; /** - * The data store is used for workspace search. Details of workspace data store - * are specified in the WorkspaceConfig. + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can be + * deleted by [CollectionService.DeleteCollection] API. * - * Value: "GOOGLE_WORKSPACE" + * Value: "FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_GoogleWorkspace; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Failed; /** - * Only contains documents without any Document.content. + * Connector initialization failed. Potential causes include runtime errors or + * issues in the asynchronous pipeline, preventing the request from reaching + * downstream services (except for some connector types). * - * Value: "NO_CONTENT" + * Value: "INITIALIZATION_FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_NoContent; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_InitializationFailed; /** - * The data store is used for public website search. + * The connector is actively syncing records from the data source. * - * Value: "PUBLIC_WEBSITE" + * Value: "RUNNING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_PublicWebsite; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Running; +/** + * Default value. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_StateUnspecified; +/** + * Connector is in the process of an update. + * + * Value: "UPDATING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Updating; +/** + * The connector has completed a sync run, but encountered non-fatal errors. + * + * Value: "WARNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Warning; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.industryVertical +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.blockingReasons /** - * The generic vertical for documents that are not specific to any industry - * vertical. + * Connector requires customer to allowlist our project in their service + * attachment. * - * Value: "GENERIC" + * Value: "ALLOWLIST_IN_SERVICE_ATTACHMENT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_Generic; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_AllowlistInServiceAttachment; /** - * The healthcare FHIR vertical. + * Connector requires customer to allowlist service account in their project. * - * Value: "HEALTHCARE_FHIR" + * Value: "ALLOWLIST_SERVICE_ACCOUNT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_HealthcareFhir; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_AllowlistServiceAccount; /** - * Value used when unset. + * Connector requires customer to allowlist static IPs. * - * Value: "INDUSTRY_VERTICAL_UNSPECIFIED" + * Value: "ALLOWLIST_STATIC_IP" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_IndustryVerticalUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_AllowlistStaticIp; /** - * The media industry vertical. + * Default value. * - * Value: "MEDIA" + * Value: "BLOCKING_REASON_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_Media; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_BlockingReasons_BlockingReasonUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.solutionTypes +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.connectorModes /** - * Used for use cases related to the Generative AI agent. + * Connector utilized for actions. * - * Value: "SOLUTION_TYPE_CHAT" + * Value: "ACTIONS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_Actions; /** - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled with - * `SOLUTION_TYPE_CHAT` solution. + * Connector mode unspecified. * - * Value: "SOLUTION_TYPE_GENERATIVE_CHAT" + * Value: "CONNECTOR_MODE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeGenerativeChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_ConnectorModeUnspecified; /** - * Used for Recommendations AI. + * Connector utilized for data ingestion. * - * Value: "SOLUTION_TYPE_RECOMMENDATION" + * Value: "DATA_INGESTION" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeRecommendation; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_DataIngestion; /** - * Used for Discovery Search. + * Connector utilized for End User Authentication. * - * Value: "SOLUTION_TYPE_SEARCH" + * Value: "EUA" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeSearch; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_Eua; /** - * Default value. + * Connector utilized for federated search. * - * Value: "SOLUTION_TYPE_UNSPECIFIED" + * Value: "FEDERATED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_Federated; +/** + * Hybrid connector utilized for federated search and End User Authentication. + * + * Value: "FEDERATED_AND_EUA" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorModes_FederatedAndEua; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.appType +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.connectorType /** - * App type for intranet search and Agentspace. + * Big query connector. * - * Value: "APP_TYPE_INTRANET" + * Value: "BIG_QUERY" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_AppType_AppTypeIntranet; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_BigQuery; /** - * All non specified apps. + * Default value. * - * Value: "APP_TYPE_UNSPECIFIED" + * Value: "CONNECTOR_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_AppType_AppTypeUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.industryVertical - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ConnectorTypeUnspecified; /** - * The generic vertical for documents that are not specific to any industry - * vertical. + * Google Cloud NetApp Volumes connector. * - * Value: "GENERIC" + * Value: "GCNV" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_Generic; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_Gcnv; /** - * The healthcare FHIR vertical. + * Data connector connects between FHIR store and VAIS datastore. * - * Value: "HEALTHCARE_FHIR" + * Value: "GCP_FHIR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_HealthcareFhir; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GcpFhir; /** - * Value used when unset. + * Google Cloud Storage connector. * - * Value: "INDUSTRY_VERTICAL_UNSPECIFIED" + * Value: "GCS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_IndustryVerticalUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_Gcs; /** - * The media industry vertical. + * Google Calendar connector. * - * Value: "MEDIA" + * Value: "GOOGLE_CALENDAR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_Media; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.solutionType - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleCalendar; /** - * Used for use cases related to the Generative AI agent. + * Google Drive connector. * - * Value: "SOLUTION_TYPE_CHAT" + * Value: "GOOGLE_DRIVE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleDrive; /** - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled with - * `SOLUTION_TYPE_CHAT` solution. + * Gmail connector. * - * Value: "SOLUTION_TYPE_GENERATIVE_CHAT" + * Value: "GOOGLE_MAIL" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeGenerativeChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleMail; /** - * Used for Recommendations AI. + * Native Cloud Identity connector for people search powered by People API. * - * Value: "SOLUTION_TYPE_RECOMMENDATION" + * Value: "NATIVE_CLOUD_IDENTITY" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeRecommendation; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_NativeCloudIdentity; /** - * Used for Discovery Search. + * Third party connector to connector to third party application. * - * Value: "SOLUTION_TYPE_SEARCH" + * Value: "THIRD_PARTY" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeSearch; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdParty; /** - * Default value. + * Connector utilized for End User Authentication features. * - * Value: "SOLUTION_TYPE_UNSPECIFIED" + * Value: "THIRD_PARTY_EUA" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdPartyEua; +/** + * Federated connector, it is a third party connector that doesn't ingestion + * data, and search is powered by third party application's API. + * + * Value: "THIRD_PARTY_FEDERATED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdPartyFederated; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features.feature +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.realtimeState /** - * The feature is turned off to be inaccessible. + * The connector is successfully set up and awaiting next sync run. * - * Value: "FEATURE_STATE_OFF" + * Value: "ACTIVE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features_Feature_FeatureStateOff; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Active; /** - * The feature is turned on to be accessible. + * The connector is being set up. * - * Value: "FEATURE_STATE_ON" + * Value: "CREATING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features_Feature_FeatureStateOn; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Creating; /** - * The feature state is unspecified. + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can be + * deleted by [CollectionService.DeleteCollection] API. * - * Value: "FEATURE_STATE_UNSPECIFIED" + * Value: "FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features_Feature_FeatureStateUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig.trainingState - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Failed; /** - * The engine training is paused. + * Connector initialization failed. Potential causes include runtime errors or + * issues in the asynchronous pipeline, preventing the request from reaching + * downstream services (except for some connector types). * - * Value: "PAUSED" + * Value: "INITIALIZATION_FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig_TrainingState_Paused; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_InitializationFailed; /** - * The engine is training. + * The connector is actively syncing records from the data source. * - * Value: "TRAINING" + * Value: "RUNNING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig_TrainingState_Training; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Running; /** - * Unspecified training state. + * Default value. * - * Value: "TRAINING_STATE_UNSPECIFIED" + * Value: "STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig_TrainingState_TrainingStateUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig.searchAddOns - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_StateUnspecified; /** - * Large language model add-on. + * Connector is in the process of an update. * - * Value: "SEARCH_ADD_ON_LLM" + * Value: "UPDATING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchAddOns_SearchAddOnLlm; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Updating; /** - * Default value when the enum is unspecified. This is invalid to use. + * The connector has completed a sync run, but encountered non-fatal errors. * - * Value: "SEARCH_ADD_ON_UNSPECIFIED" + * Value: "WARNING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchAddOns_SearchAddOnUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Warning; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig.searchTier +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.state /** - * Enterprise tier. + * The connector is successfully set up and awaiting next sync run. * - * Value: "SEARCH_TIER_ENTERPRISE" + * Value: "ACTIVE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchTier_SearchTierEnterprise; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Active; /** - * Standard tier. + * The connector is being set up. * - * Value: "SEARCH_TIER_STANDARD" + * Value: "CREATING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchTier_SearchTierStandard; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Creating; /** - * Default value when the enum is unspecified. This is invalid to use. + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can be + * deleted by [CollectionService.DeleteCollection] API. * - * Value: "SEARCH_TIER_UNSPECIFIED" + * Value: "FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchTier_SearchTierUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig.idpType - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Failed; /** - * Google 1P provider. + * Connector initialization failed. Potential causes include runtime errors or + * issues in the asynchronous pipeline, preventing the request from reaching + * downstream services (except for some connector types). * - * Value: "GSUITE" + * Value: "INITIALIZATION_FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig_IdpType_Gsuite; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_InitializationFailed; /** - * Default value. ACL search not enabled. + * The connector is actively syncing records from the data source. * - * Value: "IDP_TYPE_UNSPECIFIED" + * Value: "RUNNING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig_IdpType_IdpTypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Running; /** - * Third party provider. + * Default value. * - * Value: "THIRD_PARTY" + * Value: "STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig_IdpType_ThirdParty; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_StateUnspecified; +/** + * Connector is in the process of an update. + * + * Value: "UPDATING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Updating; +/** + * The connector has completed a sync run, but encountered non-fatal errors. + * + * Value: "WARNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Warning; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest.reconciliationMode +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector.syncMode /** - * Calculates diff and replaces the entire document dataset. Existing documents - * may be deleted if they are not present in the source location. When using - * this mode, there won't be any downtime on the dataset targeted. Any document - * that should remain unchanged or that should be updated will continue serving - * while the operation is running. + * The connector will sync data periodically based on the refresh_interval. Use + * it with auto_run_disabled to pause the periodic sync, or indicate a one-time + * sync. * - * Value: "FULL" + * Value: "PERIODIC" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_Full; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Periodic; /** - * Inserts new documents or updates existing documents. + * The data will be synced in real time. * - * Value: "INCREMENTAL" + * Value: "STREAMING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_Incremental; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Streaming; /** - * Defaults to `INCREMENTAL`. + * Connector that doesn't ingest data will have this value * - * Value: "RECONCILIATION_MODE_UNSPECIFIED" + * Value: "UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_ReconciliationModeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Unspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms.state +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError.streamingErrorReason /** - * The default value of the enum. This value is not actually used. + * Ingress endpoint is required when setting up realtime sync in private + * connectivity. * - * Value: "STATE_UNSPECIFIED" + * Value: "INGRESS_ENDPOINT_REQUIRED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_StateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_IngressEndpointRequired; /** - * The project has given consent to the terms of service. + * Streaming error reason unspecified. * - * Value: "TERMS_ACCEPTED" + * Value: "STREAMING_ERROR_REASON_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsAccepted; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingErrorReasonUnspecified; /** - * The project has declined or revoked the agreement to terms of service. + * Some error occurred while setting up resources for realtime sync. * - * Value: "TERMS_DECLINED" + * Value: "STREAMING_SETUP_ERROR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsDeclined; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSetupError; /** - * The project is pending to review and accept the terms of service. + * Some error was encountered while running realtime sync for the connector. * - * Value: "TERMS_PENDING" + * Value: "STREAMING_SYNC_ERROR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsPending; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating.category +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.configurableBillingApproach /** - * The harm category is civic integrity. + * Default value. For Spark and non-Spark non-configurable billing approach. * - * Value: "HARM_CATEGORY_CIVIC_INTEGRITY" + * Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryCivicIntegrity; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified; /** - * The harm category is dangerous content. + * Use the consumption pay-as-you-go billing for embedding storage add-on. * - * Value: "HARM_CATEGORY_DANGEROUS_CONTENT" + * Value: "CONFIGURABLE_CONSUMPTION_EMBEDDING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryDangerousContent; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding; /** - * The harm category is harassment. + * Use the subscription base + overage billing for indexing core for non + * embedding storage. * - * Value: "HARM_CATEGORY_HARASSMENT" + * Value: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryHarassment; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.contentConfig + /** - * The harm category is hate speech. + * Default value. * - * Value: "HARM_CATEGORY_HATE_SPEECH" + * Value: "CONTENT_CONFIG_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryHateSpeech; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_ContentConfigUnspecified; /** - * The harm category is sexually explicit content. + * Only contains documents with Document.content. * - * Value: "HARM_CATEGORY_SEXUALLY_EXPLICIT" + * Value: "CONTENT_REQUIRED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategorySexuallyExplicit; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_ContentRequired; /** - * The harm category is unspecified. + * The data store is used for workspace search. Details of workspace data store + * are specified in the WorkspaceConfig. * - * Value: "HARM_CATEGORY_UNSPECIFIED" + * Value: "GOOGLE_WORKSPACE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating.probability - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_GoogleWorkspace; /** - * Harm probability unspecified. + * Only contains documents without any Document.content. * - * Value: "HARM_PROBABILITY_UNSPECIFIED" + * Value: "NO_CONTENT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_HarmProbabilityUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_NoContent; /** - * High level of harm. + * The data store is used for public website search. * - * Value: "HIGH" + * Value: "PUBLIC_WEBSITE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_High; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ContentConfig_PublicWebsite; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.industryVertical + /** - * Low level of harm. + * The generic vertical for documents that are not specific to any industry + * vertical. * - * Value: "LOW" + * Value: "GENERIC" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_Low; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_Generic; /** - * Medium level of harm. + * The healthcare FHIR vertical. * - * Value: "MEDIUM" + * Value: "HEALTHCARE_FHIR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_Medium; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_HealthcareFhir; /** - * Negligible level of harm. + * Value used when unset. * - * Value: "NEGLIGIBLE" + * Value: "INDUSTRY_VERTICAL_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_Negligible; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_IndustryVerticalUnspecified; +/** + * The media industry vertical. + * + * Value: "MEDIA" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_IndustryVertical_Media; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating.severity +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore.solutionTypes /** - * High level of harm severity. + * Used for use cases related to the Generative AI agent. * - * Value: "HARM_SEVERITY_HIGH" + * Value: "SOLUTION_TYPE_CHAT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityHigh; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeChat; /** - * Low level of harm severity. + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled with + * `SOLUTION_TYPE_CHAT` solution. * - * Value: "HARM_SEVERITY_LOW" + * Value: "SOLUTION_TYPE_GENERATIVE_CHAT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityLow; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeGenerativeChat; /** - * Medium level of harm severity. + * Used for Recommendations AI. * - * Value: "HARM_SEVERITY_MEDIUM" + * Value: "SOLUTION_TYPE_RECOMMENDATION" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityMedium; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeRecommendation; /** - * Negligible level of harm severity. + * Used for Discovery Search. * - * Value: "HARM_SEVERITY_NEGLIGIBLE" + * Value: "SOLUTION_TYPE_SEARCH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityNegligible; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeSearch; /** - * Harm severity unspecified. + * Default value. * - * Value: "HARM_SEVERITY_UNSPECIFIED" + * Value: "SOLUTION_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_SolutionTypes_SolutionTypeUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest.rankingExpressionBackend +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.appType /** - * Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding - * model, the default way to evaluate the ranking expression. Legacy enum - * option, `RANK_BY_EMBEDDING` should be used instead. - * - * Value: "BYOE" - */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_Byoe GTLR_DEPRECATED; -/** - * Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy - * enum option, `RANK_BY_FORMULA` should be used instead. + * App type for intranet search and Agentspace. * - * Value: "CLEARBOX" + * Value: "APP_TYPE_INTRANET" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_Clearbox GTLR_DEPRECATED; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_AppType_AppTypeIntranet; /** - * Ranking by custom embedding model, the default way to evaluate the ranking - * expression. + * All non specified apps. * - * Value: "RANK_BY_EMBEDDING" + * Value: "APP_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_RankByEmbedding; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_AppType_AppTypeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.configurableBillingApproach + /** - * Ranking by custom formula. + * The billing approach follows configurations specified by customer. * - * Value: "RANK_BY_FORMULA" + * Value: "CONFIGURABLE_BILLING_APPROACH_ENABLED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_RankByFormula; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled; /** - * Default option for unspecified/unknown values. + * Default value. For Spark and non-Spark non-configurable billing approach. + * General pricing model. * - * Value: "RANKING_EXPRESSION_BACKEND_UNSPECIFIED" + * Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_RankingExpressionBackendUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest.relevanceThreshold +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.industryVertical /** - * High relevance threshold. - * - * Value: "HIGH" - */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_High; -/** - * Low relevance threshold. + * The generic vertical for documents that are not specific to any industry + * vertical. * - * Value: "LOW" + * Value: "GENERIC" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_Low; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_Generic; /** - * Lowest relevance threshold. + * The healthcare FHIR vertical. * - * Value: "LOWEST" + * Value: "HEALTHCARE_FHIR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_Lowest; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_HealthcareFhir; /** - * Medium relevance threshold. + * Value used when unset. * - * Value: "MEDIUM" + * Value: "INDUSTRY_VERTICAL_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_Medium; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_IndustryVerticalUnspecified; /** - * Default value. In this case, server behavior defaults to Google defined - * threshold. + * The media industry vertical. * - * Value: "RELEVANCE_THRESHOLD_UNSPECIFIED" + * Value: "MEDIA" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_RelevanceThresholdUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_IndustryVertical_Media; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec.attributeType +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine.solutionType /** - * Unspecified AttributeType. + * Used for use cases related to the Generative AI agent. * - * Value: "ATTRIBUTE_TYPE_UNSPECIFIED" + * Value: "SOLUTION_TYPE_CHAT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_AttributeTypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeChat; /** - * For the freshness use case the attribute value will be the duration between - * the current time and the date in the datetime field specified. The value - * must be formatted as an XSD `dayTimeDuration` value (a restricted subset of - * an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, - * `5D`, `3DT12H30M`, `T24H`. + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled with + * `SOLUTION_TYPE_CHAT` solution. * - * Value: "FRESHNESS" + * Value: "SOLUTION_TYPE_GENERATIVE_CHAT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Freshness; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeGenerativeChat; /** - * The value of the numerical field will be used to dynamically update the - * boost amount. In this case, the attribute_value (the x value) of the control - * point will be the actual value of the numerical field for which the - * boost_amount is specified. + * Used for Recommendations AI. * - * Value: "NUMERICAL" + * Value: "SOLUTION_TYPE_RECOMMENDATION" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Numerical; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec.interpolationType - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeRecommendation; /** - * Interpolation type is unspecified. In this case, it defaults to Linear. + * Used for Discovery Search. * - * Value: "INTERPOLATION_TYPE_UNSPECIFIED" + * Value: "SOLUTION_TYPE_SEARCH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_InterpolationTypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeSearch; /** - * Piecewise linear interpolation will be applied. + * Default value. * - * Value: "LINEAR" + * Value: "SOLUTION_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_Linear; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_SolutionType_SolutionTypeUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec.searchResultMode +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features.feature /** - * Returns chunks in the search result. Only available if the - * DocumentProcessingConfig.chunking_config is specified. + * The feature is turned off to be inaccessible. * - * Value: "CHUNKS" + * Value: "FEATURE_STATE_OFF" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec_SearchResultMode_Chunks; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features_Feature_FeatureStateOff; /** - * Returns documents in the search result. + * The feature is turned on to be accessible. * - * Value: "DOCUMENTS" + * Value: "FEATURE_STATE_ON" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec_SearchResultMode_Documents; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features_Feature_FeatureStateOn; /** - * Default value. + * The feature state is unspecified. * - * Value: "SEARCH_RESULT_MODE_UNSPECIFIED" + * Value: "FEATURE_STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec_SearchResultMode_SearchResultModeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features_Feature_FeatureStateUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.matchHighlightingCondition +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig.trainingState /** - * Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. + * The engine training is paused. * - * Value: "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED" + * Value: "PAUSED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingConditionUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig_TrainingState_Paused; /** - * Disables match highlighting on all documents. + * The engine is training. * - * Value: "MATCH_HIGHLIGHTING_DISABLED" + * Value: "TRAINING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig_TrainingState_Training; /** - * Enables match highlighting on all documents. + * Unspecified training state. * - * Value: "MATCH_HIGHLIGHTING_ENABLED" + * Value: "TRAINING_STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig_TrainingState_TrainingStateUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec.condition +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig.searchAddOns /** - * Automatic query expansion built by the Search API. - * - * Value: "AUTO" - */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_Auto; -/** - * Unspecified query expansion condition. In this case, server behavior - * defaults to Condition.DISABLED. + * Large language model add-on. * - * Value: "CONDITION_UNSPECIFIED" + * Value: "SEARCH_ADD_ON_LLM" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_ConditionUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchAddOns_SearchAddOnLlm; /** - * Disabled query expansion. Only the exact search query is used, even if - * SearchResponse.total_size is zero. + * Default value when the enum is unspecified. This is invalid to use. * - * Value: "DISABLED" + * Value: "SEARCH_ADD_ON_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_Disabled; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchAddOns_SearchAddOnUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec.condition +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig.searchTier /** - * Automatic switching between search-as-you-type and standard search modes, - * ideal for single-API implementations (e.g., debouncing). + * Enterprise tier. * - * Value: "AUTO" + * Value: "SEARCH_TIER_ENTERPRISE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_Auto; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchTier_SearchTierEnterprise; /** - * Server behavior defaults to Condition.DISABLED. + * Standard tier. * - * Value: "CONDITION_UNSPECIFIED" + * Value: "SEARCH_TIER_STANDARD" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_ConditionUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchTier_SearchTierStandard; /** - * Disables Search As You Type. - * - * Value: "DISABLED" - */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_Disabled; -/** - * Enables Search As You Type. + * Default value when the enum is unspecified. This is invalid to use. * - * Value: "ENABLED" + * Value: "SEARCH_TIER_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_Enabled; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineSearchEngineConfig_SearchTier_SearchTierUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec.mode +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig.idpType /** - * Automatic spell correction built by the Search API. Search will be based on - * the corrected query if found. + * Google 1P provider. * - * Value: "AUTO" + * Value: "GSUITE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec_Mode_Auto; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig_IdpType_Gsuite; /** - * Unspecified spell correction mode. In this case, server behavior defaults to - * Mode.AUTO. + * Default value. ACL search not enabled. * - * Value: "MODE_UNSPECIFIED" + * Value: "IDP_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec_Mode_ModeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig_IdpType_IdpTypeUnspecified; /** - * Search API tries to find a spelling suggestion. If a suggestion is found, it - * is put in the SearchResponse.corrected_query. The spelling suggestion won't - * be used as the search query. + * Third party provider. * - * Value: "SUGGESTION_ONLY" + * Value: "THIRD_PARTY" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec_Mode_SuggestionOnly; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig_IdpType_ThirdParty; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary.summarySkippedReasons +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest.reconciliationMode /** - * The adversarial query ignored case. Only used when - * SummarySpec.ignore_adversarial_query is set to `true`. + * Calculates diff and replaces the entire document dataset. Existing documents + * may be deleted if they are not present in the source location. When using + * this mode, there won't be any downtime on the dataset targeted. Any document + * that should remain unchanged or that should be updated will continue serving + * while the operation is running. * - * Value: "ADVERSARIAL_QUERY_IGNORED" + * Value: "FULL" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_AdversarialQueryIgnored; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_Full; /** - * The customer policy violation case. Google skips the summary if there is a - * customer policy violation detected. The policy is defined by the customer. + * Inserts new documents or updates existing documents. * - * Value: "CUSTOMER_POLICY_VIOLATION" + * Value: "INCREMENTAL" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_CustomerPolicyViolation; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_Incremental; /** - * The jail-breaking query ignored case. For example, "Reply in the tone of a - * competing company's CEO". Only used when - * [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is - * set to `true`. + * Defaults to `INCREMENTAL`. * - * Value: "JAIL_BREAKING_QUERY_IGNORED" + * Value: "RECONCILIATION_MODE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_JailBreakingQueryIgnored; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ImportDocumentsRequest_ReconciliationMode_ReconciliationModeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig.state + /** - * The LLM addon not enabled case. Google skips the summary if the LLM addon is - * not enabled. + * The license config is effective and being used. * - * Value: "LLM_ADDON_NOT_ENABLED" + * Value: "ACTIVE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_LlmAddonNotEnabled; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_Active; /** - * The non-summary seeking query ignored case. Google skips the summary if the - * query is chit chat. Only used when - * SummarySpec.ignore_non_summary_seeking_query is set to `true`. + * The license config has expired. * - * Value: "NON_SUMMARY_SEEKING_QUERY_IGNORED" + * Value: "EXPIRED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_NonSummarySeekingQueryIgnored; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_Expired; /** - * The non-answer seeking query ignored case. Google skips the summary if the - * query doesn't have clear intent. Only used when - * [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] - * is set to `true`. + * The license config has not started yet, and its start date is in the future. * - * Value: "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" + * Value: "NOT_STARTED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_NonSummarySeekingQueryIgnoredV2; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_NotStarted; /** - * The no relevant content case. Google skips the summary if there is no - * relevant content in the retrieved search results. + * Default value. The license config does not exist. * - * Value: "NO_RELEVANT_CONTENT" + * Value: "STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_NoRelevantContent; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_StateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig.subscriptionTerm + /** - * The out-of-domain query ignored case. Google skips the summary if there are - * no high-relevance search results. For example, the data store contains facts - * about company A but the user query is asking questions about company B. + * 1 month. * - * Value: "OUT_OF_DOMAIN_QUERY_IGNORED" + * Value: "SUBSCRIPTION_TERM_ONE_MONTH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_OutOfDomainQueryIgnored; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth; /** - * The potential policy violation case. Google skips the summary if there is a - * potential policy violation detected. This includes content that may be - * violent or toxic. + * 1 year. * - * Value: "POTENTIAL_POLICY_VIOLATION" + * Value: "SUBSCRIPTION_TERM_ONE_YEAR" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_PotentialPolicyViolation; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermOneYear; /** - * Default value. The summary skipped reason is not specified. + * 3 years. * - * Value: "SUMMARY_SKIPPED_REASON_UNSPECIFIED" + * Value: "SUBSCRIPTION_TERM_THREE_YEARS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_SummarySkippedReasonUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears; /** - * The time out case. Google skips the summary if the time out. + * Default value, do not use. * - * Value: "TIME_OUT" + * Value: "SUBSCRIPTION_TERM_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_TimeOut; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig.solutionType +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig.subscriptionTier /** - * Used for use cases related to the Generative AI agent. + * Agentspace Business tier. * - * Value: "SOLUTION_TYPE_CHAT" + * Value: "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness; /** - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled with - * `SOLUTION_TYPE_CHAT` solution. + * Agentspace Starter tier. * - * Value: "SOLUTION_TYPE_GENERATIVE_CHAT" + * Value: "SUBSCRIPTION_TIER_AGENTSPACE_STARTER" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeGenerativeChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter; /** - * Used for Recommendations AI. + * EDU tier. * - * Value: "SOLUTION_TYPE_RECOMMENDATION" + * Value: "SUBSCRIPTION_TIER_EDU" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeRecommendation; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEdu; /** - * Used for Discovery Search. + * EDU emerging market tier. * - * Value: "SOLUTION_TYPE_SEARCH" + * Value: "SUBSCRIPTION_TIER_EDU_EMERGING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeSearch; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging; /** - * Default value. + * EDU Pro tier. * - * Value: "SOLUTION_TYPE_UNSPECIFIED" + * Value: "SUBSCRIPTION_TIER_EDU_PRO" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session.state - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduPro; /** - * The session is currently open. + * EDU Pro emerging market tier. * - * Value: "IN_PROGRESS" + * Value: "SUBSCRIPTION_TIER_EDU_PRO_EMERGING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session_State_InProgress; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging; /** - * State is unspecified. + * Enterprise tier. * - * Value: "STATE_UNSPECIFIED" + * Value: "SUBSCRIPTION_TIER_ENTERPRISE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session_State_StateUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo.siteVerificationState - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEnterprise; /** - * Site exempt from verification, e.g., a public website that opens to all. + * Frontline worker tier. * - * Value: "EXEMPTED" + * Value: "SUBSCRIPTION_TIER_FRONTLINE_WORKER" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_Exempted; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker; /** - * Defaults to VERIFIED. + * NotebookLM tier. NotebookLM is a subscription tier can only access + * NotebookLM features. * - * Value: "SITE_VERIFICATION_STATE_UNSPECIFIED" + * Value: "SUBSCRIPTION_TIER_NOTEBOOK_LM" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_SiteVerificationStateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm; /** - * Site ownership pending verification or verification failed. + * Search tier. Search tier can access VAIS search features and NotebookLM + * features. * - * Value: "UNVERIFIED" + * Value: "SUBSCRIPTION_TIER_SEARCH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_Unverified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierSearch; /** - * Site ownership verified. + * Search + assistant tier. Search + assistant tier can access VAIS search + * features, NotebookLM features and assistant features. * - * Value: "VERIFIED" + * Value: "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_Verified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant; +/** + * Default value. + * + * Value: "SUBSCRIPTION_TIER_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry.matchOperator +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms.state /** - * If the suggestion contains the block_phrase, then block it. + * The default value of the enum. This value is not actually used. * - * Value: "CONTAINS" + * Value: "STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry_MatchOperator_Contains; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_StateUnspecified; /** - * If the suggestion is an exact match to the block_phrase, then block it. + * The project has given consent to the terms of service. * - * Value: "EXACT_MATCH" + * Value: "TERMS_ACCEPTED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry_MatchOperator_ExactMatch; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsAccepted; /** - * Default value. Should not be used + * The project has declined or revoked the agreement to terms of service. * - * Value: "MATCH_OPERATOR_UNSPECIFIED" + * Value: "TERMS_DECLINED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry_MatchOperator_MatchOperatorUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite.indexingStatus - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsDeclined; /** - * The target site change is pending but cancellable. + * The project is pending to review and accept the terms of service. * - * Value: "CANCELLABLE" + * Value: "TERMS_PENDING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Cancellable; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectServiceTerms_State_TermsPending; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating.category + /** - * The target site change is cancelled. + * The harm category is civic integrity. * - * Value: "CANCELLED" + * Value: "HARM_CATEGORY_CIVIC_INTEGRITY" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Cancelled; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryCivicIntegrity; /** - * The previously indexed target site has been marked to be deleted. This is a - * transitioning state which will resulted in either: 1. target site deleted if - * unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing - * fails. + * The harm category is dangerous content. * - * Value: "DELETING" + * Value: "HARM_CATEGORY_DANGEROUS_CONTENT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Deleting; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryDangerousContent; /** - * The target site fails to be indexed. + * The harm category is harassment. * - * Value: "FAILED" + * Value: "HARM_CATEGORY_HARASSMENT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Failed; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryHarassment; /** - * Defaults to SUCCEEDED. + * The harm category is hate speech. * - * Value: "INDEXING_STATUS_UNSPECIFIED" + * Value: "HARM_CATEGORY_HATE_SPEECH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_IndexingStatusUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryHateSpeech; /** - * The target site is in the update queue and will be picked up by indexing - * pipeline. + * The harm category is sexually explicit content. * - * Value: "PENDING" + * Value: "HARM_CATEGORY_SEXUALLY_EXPLICIT" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Pending; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategorySexuallyExplicit; /** - * The target site has been indexed. + * The harm category is unspecified. * - * Value: "SUCCEEDED" + * Value: "HARM_CATEGORY_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Succeeded; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Category_HarmCategoryUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite.type +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating.probability /** - * Exclude the target site. + * Harm probability unspecified. * - * Value: "EXCLUDE" + * Value: "HARM_PROBABILITY_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_Type_Exclude; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_HarmProbabilityUnspecified; /** - * Include the target site. + * High level of harm. * - * Value: "INCLUDE" + * Value: "HIGH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_Type_Include; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_High; /** - * This value is unused. In this case, server behavior defaults to - * Type.INCLUDE. + * Low level of harm. * - * Value: "TYPE_UNSPECIFIED" + * Value: "LOW" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_Type_TypeUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense.licenseAssignmentState - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_Low; /** - * License assigned to the user. + * Medium level of harm. * - * Value: "ASSIGNED" + * Value: "MEDIUM" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_Assigned; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_Medium; /** - * User is blocked from assigning a license. + * Negligible level of harm. * - * Value: "BLOCKED" + * Value: "NEGLIGIBLE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_Blocked; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Probability_Negligible; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating.severity + /** - * Default value. + * High level of harm severity. * - * Value: "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED" + * Value: "HARM_SEVERITY_HIGH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_LicenseAssignmentStateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityHigh; /** - * No license assigned to the user. + * Low level of harm severity. * - * Value: "NO_LICENSE" + * Value: "HARM_SEVERITY_LOW" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_NoLicense; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityLow; /** - * User attempted to login but no license assigned to the user. This state is - * only used for no user first time login attempt but cannot get license - * assigned. Users already logged in but cannot get license assigned will be - * assigned NO_LICENSE state(License could be unassigned by admin). + * Medium level of harm severity. * - * Value: "NO_LICENSE_ATTEMPTED_LOGIN" + * Value: "HARM_SEVERITY_MEDIUM" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_NoLicenseAttemptedLogin; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityMedium; /** - * No license assigned to the user. Deprecated, translated to NO_LICENSE. + * Negligible level of harm severity. * - * Value: "UNASSIGNED" + * Value: "HARM_SEVERITY_NEGLIGIBLE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_Unassigned; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityNegligible; +/** + * Harm severity unspecified. + * + * Value: "HARM_SEVERITY_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SafetyRating_Severity_HarmSeverityUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig.type +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest.rankingExpressionBackend /** - * Workspace Data Store contains Calendar data + * Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding + * model, the default way to evaluate the ranking expression. Legacy enum + * option, `RANK_BY_EMBEDDING` should be used instead. * - * Value: "GOOGLE_CALENDAR" + * Value: "BYOE" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleCalendar; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_Byoe GTLR_DEPRECATED; /** - * Workspace Data Store contains Chat data + * Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy + * enum option, `RANK_BY_FORMULA` should be used instead. * - * Value: "GOOGLE_CHAT" + * Value: "CLEARBOX" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleChat; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_Clearbox GTLR_DEPRECATED; /** - * Workspace Data Store contains Drive data + * Ranking by custom embedding model, the default way to evaluate the ranking + * expression. * - * Value: "GOOGLE_DRIVE" + * Value: "RANK_BY_EMBEDDING" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleDrive; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_RankByEmbedding; /** - * Workspace Data Store contains Groups data + * Ranking by custom formula. * - * Value: "GOOGLE_GROUPS" + * Value: "RANK_BY_FORMULA" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleGroups; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_RankByFormula; /** - * Workspace Data Store contains Keep data + * Default option for unspecified/unknown values. * - * Value: "GOOGLE_KEEP" + * Value: "RANKING_EXPRESSION_BACKEND_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleKeep; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RankingExpressionBackend_RankingExpressionBackendUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest.relevanceThreshold + /** - * Workspace Data Store contains Mail data + * High relevance threshold. * - * Value: "GOOGLE_MAIL" + * Value: "HIGH" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleMail; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_High; /** - * Workspace Data Store contains People data + * Low relevance threshold. * - * Value: "GOOGLE_PEOPLE" + * Value: "LOW" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GooglePeople; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_Low; /** - * Workspace Data Store contains Sites data + * Lowest relevance threshold. * - * Value: "GOOGLE_SITES" + * Value: "LOWEST" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleSites; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_Lowest; /** - * Defaults to an unspecified Workspace type. + * Medium relevance threshold. * - * Value: "TYPE_UNSPECIFIED" + * Value: "MEDIUM" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_TypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_Medium; +/** + * Default value. In this case, server behavior defaults to Google defined + * threshold. + * + * Value: "RELEVANCE_THRESHOLD_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest_RelevanceThreshold_RelevanceThresholdUnspecified; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries.metricKind +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec.attributeType /** - * A value accumulated over a time interval. Cumulative measurements in a time - * series should have the same start time and increasing end times, until an - * event resets the cumulative value to zero and sets a new start time for the - * following points. + * Unspecified AttributeType. * - * Value: "CUMULATIVE" + * Value: "ATTRIBUTE_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_Cumulative; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_AttributeTypeUnspecified; /** - * The change in a value during a time interval. + * For the freshness use case the attribute value will be the duration between + * the current time and the date in the datetime field specified. The value + * must be formatted as an XSD `dayTimeDuration` value (a restricted subset of + * an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, + * `5D`, `3DT12H30M`, `T24H`. * - * Value: "DELTA" + * Value: "FRESHNESS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_Delta; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Freshness; /** - * An instantaneous measurement of a value. + * The value of the numerical field will be used to dynamically update the + * boost amount. In this case, the attribute_value (the x value) of the control + * point will be the actual value of the numerical field for which the + * boost_amount is specified. * - * Value: "GAUGE" + * Value: "NUMERICAL" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_Gauge; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Numerical; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec.interpolationType + /** - * Do not use this default value. + * Interpolation type is unspecified. In this case, it defaults to Linear. * - * Value: "METRIC_KIND_UNSPECIFIED" + * Value: "INTERPOLATION_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_MetricKindUnspecified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_InterpolationTypeUnspecified; +/** + * Piecewise linear interpolation will be applied. + * + * Value: "LINEAR" + */ +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_Linear; // ---------------------------------------------------------------------------- -// GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries.valueType +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec.searchResultMode /** - * The value is a boolean. This value type can be used only if the metric kind - * is `GAUGE`. + * Returns chunks in the search result. Only available if the + * DocumentProcessingConfig.chunking_config is specified. * - * Value: "BOOL" + * Value: "CHUNKS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Bool; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec_SearchResultMode_Chunks; /** - * The value is a `Distribution`. + * Returns documents in the search result. * - * Value: "DISTRIBUTION" + * Value: "DOCUMENTS" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Distribution; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec_SearchResultMode_Documents; /** - * The value is a double precision floating point number. + * Default value. * - * Value: "DOUBLE" + * Value: "SEARCH_RESULT_MODE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Double; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec_SearchResultMode_SearchResultModeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec.matchHighlightingCondition + /** - * The value is a signed 64-bit integer. + * Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. * - * Value: "INT64" + * Value: "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Int64; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingConditionUnspecified; /** - * The value is money. + * Disables match highlighting on all documents. * - * Value: "MONEY" + * Value: "MATCH_HIGHLIGHTING_DISABLED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Money; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled; /** - * The value is a text string. This value type can be used only if the metric - * kind is `GAUGE`. + * Enables match highlighting on all documents. * - * Value: "STRING" + * Value: "MATCH_HIGHLIGHTING_ENABLED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_String; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec.extractedFilterBehavior + /** - * Do not use this default value. + * `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for + * extracted filters. For single datastore search, the default is to apply as + * hard filters. For multi-datastore search, the default is to apply as soft + * boosts. * - * Value: "VALUE_TYPE_UNSPECIFIED" + * Value: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_ValueTypeUnspecified; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified; /** - * Information to read/write to blobstore2. + * Applies all extracted filters as hard filters on the results. Results that + * do not pass the extracted filters will not be returned in the result set. + * + * Value: "HARD_FILTER" */ -@interface GTLRDiscoveryEngine_GdataBlobstore2Info : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter; /** - * The blob generation id. + * Applies all extracted filters as soft boosts. Results that pass the filters + * will be boosted up to higher ranks in the result set. * - * Uses NSNumber of longLongValue. + * Value: "SOFT_BOOST" */ -@property(nonatomic, strong, nullable) NSNumber *blobGeneration; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost; -/** The blob id, e.g., /blobstore/prod/playground/scotty */ -@property(nonatomic, copy, nullable) NSString *blobId; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec.filterExtractionCondition /** - * Read handle passed from Bigstore -> Scotty for a GCS download. This is a - * signed, serialized blobstore2.ReadHandle proto which must never be set - * outside of Bigstore, and is not applicable to non-GCS media downloads. + * Server behavior defaults to `DISABLED`. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "CONDITION_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *downloadReadHandle; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified; /** - * The blob read token. Needed to read blobs that have not been replicated. - * Might not be available until the final call. + * Disables NL filter extraction. + * + * Value: "DISABLED" */ -@property(nonatomic, copy, nullable) NSString *readToken; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled; /** - * Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a - * signed, serialized blobstore2.BlobMetadataContainer proto which must never - * be consumed outside of Bigstore, and is not applicable to non-GCS media - * uploads. + * Enables NL filter extraction. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "ENABLED" */ -@property(nonatomic, copy, nullable) NSString *uploadMetadataContainer; - -@end +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec.condition /** - * A sequence of media data references representing composite data. Introduced - * to support Bigstore composite objects. For details, visit - * http://go/bigstore-composites. + * Automatic query expansion built by the Search API. + * + * Value: "AUTO" */ -@interface GTLRDiscoveryEngine_GdataCompositeMedia : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_Auto; /** - * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should - * be the byte representation of a blobstore.BlobRef. Since Blobstore is - * deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - * be represented in this field as v1 BlobRef. + * Unspecified query expansion condition. In this case, server behavior + * defaults to Condition.DISABLED. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "CONDITION_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *blobRef GTLR_DEPRECATED; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_ConditionUnspecified; /** - * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a - * v2 blob. + * Disabled query expansion. Only the exact search query is used, even if + * SearchResponse.total_size is zero. + * + * Value: "DISABLED" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataBlobstore2Info *blobstore2Info; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec_Condition_Disabled; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec.condition /** - * A binary data reference for a media download. Serves as a - * technology-agnostic binary reference in some Google infrastructure. This - * value is a serialized storage_cosmo.BinaryReference proto. Storing it as - * bytes is a hack to get around the fact that the cosmo proto (as well as - * others it includes) doesn't support JavaScript. This prevents us from - * including the actual type of this field. + * Automatic switching between search-as-you-type and standard search modes, + * ideal for single-API implementations (e.g., debouncing). * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "AUTO" */ -@property(nonatomic, copy, nullable) NSString *cosmoBinaryReference; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_Auto; /** - * crc32.c hash for the payload. + * Server behavior defaults to Condition.DISABLED. * - * Uses NSNumber of unsignedIntValue. + * Value: "CONDITION_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *crc32cHash; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_ConditionUnspecified; /** - * Media data, set if reference_type is INLINE - * - * Remapped to 'inlineProperty' to avoid language reserved word 'inline'. + * Disables Search As You Type. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "DISABLED" */ -@property(nonatomic, copy, nullable) NSString *inlineProperty; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_Disabled; /** - * Size of the data, in bytes + * Enables Search As You Type. * - * Uses NSNumber of longLongValue. + * Value: "ENABLED" */ -@property(nonatomic, strong, nullable) NSNumber *length; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec_Condition_Enabled; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec.mode /** - * MD5 hash for the payload. + * Automatic spell correction built by the Search API. Search will be based on + * the corrected query if found. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "AUTO" */ -@property(nonatomic, copy, nullable) NSString *md5Hash; - -/** Reference to a TI Blob, set if reference_type is BIGSTORE_REF. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataObjectId *objectId; - -/** Path to the data, set if reference_type is PATH */ -@property(nonatomic, copy, nullable) NSString *path; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec_Mode_Auto; /** - * Describes what the field reference contains. + * Unspecified spell correction mode. In this case, server behavior defaults to + * Mode.AUTO. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_BigstoreRef - * Reference points to a bigstore object (Value: "BIGSTORE_REF") - * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_BlobRef - * Reference points to a blobstore object. This could be either a v1 - * blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - * first, since v1 is being deprecated. (Value: "BLOB_REF") - * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_CosmoBinaryReference - * Indicates the data is stored in cosmo_binary_reference. (Value: - * "COSMO_BINARY_REFERENCE") - * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_Inline Data - * is included into this proto buffer (Value: "INLINE") - * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_Path - * Reference contains a GFS path or a local path. (Value: "PATH") + * Value: "MODE_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *referenceType; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec_Mode_ModeUnspecified; /** - * SHA-1 hash for the payload. + * Search API tries to find a spelling suggestion. If a suggestion is found, it + * is put in the SearchResponse.corrected_query. The spelling suggestion won't + * be used as the search query. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "SUGGESTION_ONLY" */ -@property(nonatomic, copy, nullable) NSString *sha1Hash; - -@end +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec_Mode_SuggestionOnly; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary.summarySkippedReasons /** - * Detailed Content-Type information from Scotty. The Content-Type of the media - * will typically be filled in by the header or Scotty's best_guess, but this - * extended information provides the backend with more information so that it - * can make a better decision if needed. This is only used on media upload - * requests from Scotty. + * The adversarial query ignored case. Only used when + * SummarySpec.ignore_adversarial_query is set to `true`. + * + * Value: "ADVERSARIAL_QUERY_IGNORED" */ -@interface GTLRDiscoveryEngine_GdataContentTypeInfo : GTLRObject - -/** Scotty's best guess of what the content type of the file is. */ -@property(nonatomic, copy, nullable) NSString *bestGuess; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_AdversarialQueryIgnored; /** - * The content type of the file derived by looking at specific bytes (i.e. - * "magic bytes") of the actual file. + * The customer policy violation case. Google skips the summary if there is a + * customer policy violation detected. The policy is defined by the customer. + * + * Value: "CUSTOMER_POLICY_VIOLATION" */ -@property(nonatomic, copy, nullable) NSString *fromBytes; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_CustomerPolicyViolation; /** - * The content type of the file derived from the file extension of the original - * file name used by the client. + * The jail-breaking query ignored case. For example, "Reply in the tone of a + * competing company's CEO". Only used when + * [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is + * set to `true`. + * + * Value: "JAIL_BREAKING_QUERY_IGNORED" */ -@property(nonatomic, copy, nullable) NSString *fromFileName; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_JailBreakingQueryIgnored; /** - * The content type of the file as specified in the request headers, multipart - * headers, or RUPIO start request. + * The LLM addon not enabled case. Google skips the summary if the LLM addon is + * not enabled. + * + * Value: "LLM_ADDON_NOT_ENABLED" */ -@property(nonatomic, copy, nullable) NSString *fromHeader; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_LlmAddonNotEnabled; /** - * The content type of the file derived from the file extension of the URL - * path. The URL path is assumed to represent a file name (which is typically - * only true for agents that are providing a REST API). + * The non-summary seeking query ignored case. Google skips the summary if the + * query is chit chat. Only used when + * SummarySpec.ignore_non_summary_seeking_query is set to `true`. + * + * Value: "NON_SUMMARY_SEEKING_QUERY_IGNORED" */ -@property(nonatomic, copy, nullable) NSString *fromUrlPath; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_NonSummarySeekingQueryIgnored; /** - * Backend response for a Diff get checksums response. For details on the - * Scotty Diff protocol, visit http://go/scotty-diff-protocol. + * The non-answer seeking query ignored case. Google skips the summary if the + * query doesn't have clear intent. Only used when + * [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] + * is set to `true`. + * + * Value: "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" */ -@interface GTLRDiscoveryEngine_GdataDiffChecksumsResponse : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_NonSummarySeekingQueryIgnoredV2; /** - * Exactly one of these fields must be populated. If checksums_location is - * filled, the server will return the corresponding contents to the user. If - * object_location is filled, the server will calculate the checksums based on - * the content there and return that to the user. For details on the format of - * the checksums, see http://go/scotty-diff-protocol. + * The no relevant content case. Google skips the summary if there is no + * relevant content in the retrieved search results. + * + * Value: "NO_RELEVANT_CONTENT" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *checksumsLocation; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_NoRelevantContent; /** - * The chunk size of checksums. Must be a multiple of 256KB. + * The out-of-domain query ignored case. Google skips the summary if there are + * no high-relevance search results. For example, the data store contains facts + * about company A but the user query is asking questions about company B. * - * Uses NSNumber of longLongValue. + * Value: "OUT_OF_DOMAIN_QUERY_IGNORED" */ -@property(nonatomic, strong, nullable) NSNumber *chunkSizeBytes; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_OutOfDomainQueryIgnored; /** - * If set, calculate the checksums based on the contents and return them to the - * caller. + * The potential policy violation case. Google skips the summary if there is a + * potential policy violation detected. This includes content that may be + * violent or toxic. + * + * Value: "POTENTIAL_POLICY_VIOLATION" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *objectLocation; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_PotentialPolicyViolation; /** - * The total size of the server object. + * Default value. The summary skipped reason is not specified. * - * Uses NSNumber of longLongValue. + * Value: "SUMMARY_SKIPPED_REASON_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *objectSizeBytes; - -/** The object version of the object the checksums are being returned for. */ -@property(nonatomic, copy, nullable) NSString *objectVersion; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_SummarySkippedReasonUnspecified; /** - * Backend response for a Diff download response. For details on the Scotty - * Diff protocol, visit http://go/scotty-diff-protocol. + * The time out case. Google skips the summary if the time out. + * + * Value: "TIME_OUT" */ -@interface GTLRDiscoveryEngine_GdataDiffDownloadResponse : GTLRObject - -/** The original object location. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *objectLocation; - -@end +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchResponseSummary_SummarySkippedReasons_TimeOut; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig.solutionType /** - * A Diff upload request. For details on the Scotty Diff protocol, visit - * http://go/scotty-diff-protocol. + * Used for use cases related to the Generative AI agent. + * + * Value: "SOLUTION_TYPE_CHAT" */ -@interface GTLRDiscoveryEngine_GdataDiffUploadRequest : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeChat; /** - * The location of the checksums for the new object. Agents must clone the - * object located here, as the upload server will delete the contents once a - * response is received. For details on the format of the checksums, see - * http://go/scotty-diff-protocol. + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled with + * `SOLUTION_TYPE_CHAT` solution. + * + * Value: "SOLUTION_TYPE_GENERATIVE_CHAT" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *checksumsInfo; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeGenerativeChat; /** - * The location of the new object. Agents must clone the object located here, - * as the upload server will delete the contents once a response is received. + * Used for Recommendations AI. + * + * Value: "SOLUTION_TYPE_RECOMMENDATION" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *objectInfo; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeRecommendation; /** - * The object version of the object that is the base version the incoming diff - * script will be applied to. This field will always be filled in. + * Used for Discovery Search. + * + * Value: "SOLUTION_TYPE_SEARCH" */ -@property(nonatomic, copy, nullable) NSString *objectVersion; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeSearch; /** - * Backend response for a Diff upload request. For details on the Scotty Diff - * protocol, visit http://go/scotty-diff-protocol. + * Default value. + * + * Value: "SOLUTION_TYPE_UNSPECIFIED" */ -@interface GTLRDiscoveryEngine_GdataDiffUploadResponse : GTLRObject +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ServingConfig_SolutionType_SolutionTypeUnspecified; -/** - * The object version of the object at the server. Must be included in the end - * notification response. The version in the end notification response must - * correspond to the new version of the object that is now stored at the - * server, after the upload. - */ -@property(nonatomic, copy, nullable) NSString *objectVersion; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session.state /** - * The location of the original file for a diff upload request. Must be filled - * in if responding to an upload start notification. + * The session is currently open. + * + * Value: "IN_PROGRESS" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *originalObject; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session_State_InProgress; /** - * Backend response for a Diff get version response. For details on the Scotty - * Diff protocol, visit http://go/scotty-diff-protocol. + * State is unspecified. + * + * Value: "STATE_UNSPECIFIED" */ -@interface GTLRDiscoveryEngine_GdataDiffVersionResponse : GTLRObject +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Session_State_StateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo.siteVerificationState /** - * The total size of the server object. + * Site exempt from verification, e.g., a public website that opens to all. * - * Uses NSNumber of longLongValue. + * Value: "EXEMPTED" */ -@property(nonatomic, strong, nullable) NSNumber *objectSizeBytes; - -/** The version of the object stored at the server. */ -@property(nonatomic, copy, nullable) NSString *objectVersion; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_Exempted; /** - * Parameters specific to media downloads. + * Defaults to VERIFIED. + * + * Value: "SITE_VERIFICATION_STATE_UNSPECIFIED" */ -@interface GTLRDiscoveryEngine_GdataDownloadParameters : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_SiteVerificationStateUnspecified; /** - * A boolean to be returned in the response to Scotty. Allows/disallows gzip - * encoding of the payload content when the server thinks it's advantageous - * (hence, does not guarantee compression) which allows Scotty to GZip the - * response to the client. + * Site ownership pending verification or verification failed. * - * Uses NSNumber of boolValue. + * Value: "UNVERIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *allowGzipCompression; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_Unverified; /** - * Determining whether or not Apiary should skip the inclusion of any - * Content-Range header on its response to Scotty. + * Site ownership verified. * - * Uses NSNumber of boolValue. + * Value: "VERIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *ignoreRange; - -@end +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SiteVerificationInfo_SiteVerificationState_Verified; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry.matchOperator /** - * A reference to data stored on the filesystem, on GFS or in blobstore. + * If the suggestion contains the block_phrase, then block it. + * + * Value: "CONTAINS" */ -@interface GTLRDiscoveryEngine_GdataMedia : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry_MatchOperator_Contains; /** - * Deprecated, use one of explicit hash type fields instead. Algorithm used for - * calculating the hash. As of 2011/01/21, "MD5" is the only possible value for - * this field. New values may be added at any time. + * If the suggestion is an exact match to the block_phrase, then block it. + * + * Value: "EXACT_MATCH" */ -@property(nonatomic, copy, nullable) NSString *algorithm GTLR_DEPRECATED; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry_MatchOperator_ExactMatch; /** - * Use object_id instead. + * Default value. Should not be used * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "MATCH_OPERATOR_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *bigstoreObjectRef GTLR_DEPRECATED; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SuggestionDenyListEntry_MatchOperator_MatchOperatorUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite.indexingStatus /** - * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should - * be the byte representation of a blobstore.BlobRef. Since Blobstore is - * deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - * be represented in this field as v1 BlobRef. + * The target site change is pending but cancellable. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "CANCELLABLE" */ -@property(nonatomic, copy, nullable) NSString *blobRef GTLR_DEPRECATED; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Cancellable; /** - * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a - * v2 blob. + * The target site change is cancelled. + * + * Value: "CANCELLED" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataBlobstore2Info *blobstore2Info; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Cancelled; /** - * A composite media composed of one or more media objects, set if - * reference_type is COMPOSITE_MEDIA. The media length field must be set to the - * sum of the lengths of all composite media objects. Note: All composite media - * must have length specified. + * The previously indexed target site has been marked to be deleted. This is a + * transitioning state which will resulted in either: 1. target site deleted if + * unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing + * fails. + * + * Value: "DELETING" */ -@property(nonatomic, strong, nullable) NSArray *compositeMedia; - -/** MIME type of the data */ -@property(nonatomic, copy, nullable) NSString *contentType; - -/** Extended content type information provided for Scotty uploads. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataContentTypeInfo *contentTypeInfo; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Deleting; /** - * A binary data reference for a media download. Serves as a - * technology-agnostic binary reference in some Google infrastructure. This - * value is a serialized storage_cosmo.BinaryReference proto. Storing it as - * bytes is a hack to get around the fact that the cosmo proto (as well as - * others it includes) doesn't support JavaScript. This prevents us from - * including the actual type of this field. + * The target site fails to be indexed. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "FAILED" */ -@property(nonatomic, copy, nullable) NSString *cosmoBinaryReference; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Failed; /** - * For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: - * (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash - * provided by the agent to be used to verify the data being downloaded. - * Currently only supported for inline payloads. Further, only crc32c_hash is - * currently supported. + * Defaults to SUCCEEDED. * - * Uses NSNumber of unsignedIntValue. + * Value: "INDEXING_STATUS_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *crc32cHash; - -/** Set if reference_type is DIFF_CHECKSUMS_RESPONSE. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffChecksumsResponse *diffChecksumsResponse; - -/** Set if reference_type is DIFF_DOWNLOAD_RESPONSE. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffDownloadResponse *diffDownloadResponse; - -/** Set if reference_type is DIFF_UPLOAD_REQUEST. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffUploadRequest *diffUploadRequest; - -/** Set if reference_type is DIFF_UPLOAD_RESPONSE. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffUploadResponse *diffUploadResponse; - -/** Set if reference_type is DIFF_VERSION_RESPONSE. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffVersionResponse *diffVersionResponse; - -/** Parameters for a media download. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDownloadParameters *downloadParameters; - -/** Original file name */ -@property(nonatomic, copy, nullable) NSString *filename; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_IndexingStatusUnspecified; /** - * Deprecated, use one of explicit hash type fields instead. These two hash - * related fields will only be populated on Scotty based media uploads and will - * contain the content of the hash group in the NotificationRequest: - * http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash - * Hex encoded hash value of the uploaded media. + * The target site is in the update queue and will be picked up by indexing + * pipeline. * - * Remapped to 'hashProperty' to avoid NSObject's 'hash'. + * Value: "PENDING" */ -@property(nonatomic, copy, nullable) NSString *hashProperty GTLR_DEPRECATED; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Pending; /** - * For Scotty uploads only. If a user sends a hash code and the backend has - * requested that Scotty verify the upload against the client hash, Scotty will - * perform the check on behalf of the backend and will reject it if the hashes - * don't match. This is set to true if Scotty performed this verification. + * The target site has been indexed. * - * Uses NSNumber of boolValue. + * Value: "SUCCEEDED" */ -@property(nonatomic, strong, nullable) NSNumber *hashVerified; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_IndexingStatus_Succeeded; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite.type /** - * Media data, set if reference_type is INLINE + * Exclude the target site. * - * Remapped to 'inlineProperty' to avoid language reserved word 'inline'. - * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "EXCLUDE" */ -@property(nonatomic, copy, nullable) NSString *inlineProperty; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_Type_Exclude; /** - * |is_potential_retry| is set false only when Scotty is certain that it has - * not sent the request before. When a client resumes an upload, this field - * must be set true in agent calls, because Scotty cannot be certain that it - * has never sent the request before due to potential failure in the session - * state persistence. + * Include the target site. * - * Uses NSNumber of boolValue. + * Value: "INCLUDE" */ -@property(nonatomic, strong, nullable) NSNumber *isPotentialRetry; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_Type_Include; /** - * Size of the data, in bytes + * This value is unused. In this case, server behavior defaults to + * Type.INCLUDE. * - * Uses NSNumber of longLongValue. + * Value: "TYPE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *length; +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite_Type_TypeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense.licenseAssignmentState /** - * Scotty-provided MD5 hash for an upload. + * License assigned to the user. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "ASSIGNED" */ -@property(nonatomic, copy, nullable) NSString *md5Hash; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_Assigned; /** - * Media id to forward to the operation GetMedia. Can be set if reference_type - * is GET_MEDIA. + * User is blocked from assigning a license. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "BLOCKED" */ -@property(nonatomic, copy, nullable) NSString *mediaId; - -/** Reference to a TI Blob, set if reference_type is BIGSTORE_REF. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataObjectId *objectId; - -/** Path to the data, set if reference_type is PATH */ -@property(nonatomic, copy, nullable) NSString *path; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_Blocked; /** - * Describes what the field reference contains. + * Default value. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_ArbitraryBytes - * Informs Scotty to generate a response payload with the size specified - * in the length field. The contents of the payload are generated by - * Scotty and are undefined. This is useful for testing download speeds - * between the user and Scotty without involving a real payload source. - * Note: range is not supported when using arbitrary_bytes. (Value: - * "ARBITRARY_BYTES") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_BigstoreRef - * Reference points to a bigstore object (Value: "BIGSTORE_REF") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_BlobRef Reference - * points to a blobstore object. This could be either a v1 blob_ref or a - * v2 blobstore2_info. Clients should check blobstore2_info first, since - * v1 is being deprecated. (Value: "BLOB_REF") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_CompositeMedia The - * content for this media object is stored across multiple partial media - * objects under the composite_media field. (Value: "COMPOSITE_MEDIA") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_CosmoBinaryReference - * Indicates the data is stored in cosmo_binary_reference. (Value: - * "COSMO_BINARY_REFERENCE") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffChecksumsResponse - * Indicates the data is stored in diff_checksums_response. (Value: - * "DIFF_CHECKSUMS_RESPONSE") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffDownloadResponse - * Indicates the data is stored in diff_download_response. (Value: - * "DIFF_DOWNLOAD_RESPONSE") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffUploadRequest - * Indicates the data is stored in diff_upload_request. (Value: - * "DIFF_UPLOAD_REQUEST") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffUploadResponse - * Indicates the data is stored in diff_upload_response. (Value: - * "DIFF_UPLOAD_RESPONSE") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffVersionResponse - * Indicates the data is stored in diff_version_response. (Value: - * "DIFF_VERSION_RESPONSE") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_GetMedia Data should - * be accessed from the current service using the operation GetMedia. - * (Value: "GET_MEDIA") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_Inline Data is - * included into this proto buffer (Value: "INLINE") - * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_Path Reference - * contains a GFS path or a local path. (Value: "PATH") + * Value: "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *referenceType; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_LicenseAssignmentStateUnspecified; /** - * Scotty-provided SHA1 hash for an upload. + * No license assigned to the user. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "NO_LICENSE" */ -@property(nonatomic, copy, nullable) NSString *sha1Hash; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_NoLicense; /** - * Scotty-provided SHA256 hash for an upload. + * User attempted to login but no license assigned to the user. This state is + * only used for no user first time login attempt but cannot get license + * assigned. Users already logged in but cannot get license assigned will be + * assigned NO_LICENSE state(License could be unassigned by admin). * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Value: "NO_LICENSE_ATTEMPTED_LOGIN" */ -@property(nonatomic, copy, nullable) NSString *sha256Hash; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_NoLicenseAttemptedLogin; /** - * Time at which the media data was last updated, in milliseconds since UNIX - * epoch + * No license assigned to the user. Deprecated, translated to NO_LICENSE. * - * Uses NSNumber of unsignedLongLongValue. + * Value: "UNASSIGNED" */ -@property(nonatomic, strong, nullable) NSNumber *timestamp; - -/** A unique fingerprint/version id for the media data */ -@property(nonatomic, copy, nullable) NSString *token; - -@end +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserLicense_LicenseAssignmentState_Unassigned; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig.type /** - * This is a copy of the tech.blob.ObjectId proto, which could not be used - * directly here due to transitive closure issues with JavaScript support; see - * http://b/8801763. + * Workspace Data Store contains Calendar data + * + * Value: "GOOGLE_CALENDAR" */ -@interface GTLRDiscoveryEngine_GdataObjectId : GTLRObject - -/** The name of the bucket to which this object belongs. */ -@property(nonatomic, copy, nullable) NSString *bucketName; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleCalendar; /** - * Generation of the object. Generations are monotonically increasing across - * writes, allowing them to be be compared to determine which generation is - * newer. If this is omitted in a request, then you are requesting the live - * object. See http://go/bigstore-versions + * Workspace Data Store contains Chat data * - * Uses NSNumber of longLongValue. + * Value: "GOOGLE_CHAT" */ -@property(nonatomic, strong, nullable) NSNumber *generation; - -/** The name of the object. */ -@property(nonatomic, copy, nullable) NSString *objectName; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleChat; /** - * `Distribution` contains summary statistics for a population of values. It - * optionally contains a histogram representing the distribution of those - * values across a set of buckets. The summary statistics are the count, mean, - * sum of the squared deviation from the mean, the minimum, and the maximum of - * the set of population of values. The histogram is based on a sequence of - * buckets and gives a count of values that fall into each bucket. The - * boundaries of the buckets are given either explicitly or by formulas for - * buckets of fixed or exponentially increasing widths. Although it is not - * forbidden, it is generally a bad idea to include non-finite values - * (infinities or NaNs) in the population of values, as this will render the - * `mean` and `sum_of_squared_deviation` fields meaningless. + * Workspace Data Store contains Drive data + * + * Value: "GOOGLE_DRIVE" */ -@interface GTLRDiscoveryEngine_GoogleApiDistribution : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleDrive; /** - * The number of values in each bucket of the histogram, as described in - * `bucket_options`. If the distribution does not have a histogram, then omit - * this field. If there is a histogram, then the sum of the values in - * `bucket_counts` must equal the value in the `count` field of the - * distribution. If present, `bucket_counts` should contain N values, where N - * is the number of buckets specified in `bucket_options`. If you supply fewer - * than N values, the remaining values are assumed to be 0. The order of the - * values in `bucket_counts` follows the bucket numbering schemes described for - * the three bucket types. The first value must be the count for the underflow - * bucket (number 0). The next N-2 values are the counts for the finite buckets - * (number 1 through N-2). The N'th value in `bucket_counts` is the count for - * the overflow bucket (number N-1). + * Workspace Data Store contains Groups data * - * Uses NSNumber of longLongValue. + * Value: "GOOGLE_GROUPS" */ -@property(nonatomic, strong, nullable) NSArray *bucketCounts; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleGroups; /** - * Defines the histogram bucket boundaries. If the distribution does not - * contain a histogram, then omit this field. + * Workspace Data Store contains Keep data + * + * Value: "GOOGLE_KEEP" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptions *bucketOptions; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleKeep; /** - * The number of values in the population. Must be non-negative. This value - * must equal the sum of the values in `bucket_counts` if a histogram is - * provided. + * Workspace Data Store contains Mail data * - * Uses NSNumber of longLongValue. + * Value: "GOOGLE_MAIL" */ -@property(nonatomic, strong, nullable) NSNumber *count; - -/** Must be in increasing order of `value` field. */ -@property(nonatomic, strong, nullable) NSArray *exemplars; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleMail; /** - * The arithmetic mean of the values in the population. If `count` is zero then - * this field must be zero. + * Workspace Data Store contains People data * - * Uses NSNumber of doubleValue. + * Value: "GOOGLE_PEOPLE" */ -@property(nonatomic, strong, nullable) NSNumber *mean; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GooglePeople; /** - * If specified, contains the range of the population values. The field must - * not be present if the `count` is zero. + * Workspace Data Store contains Sites data + * + * Value: "GOOGLE_SITES" */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionRange *range; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_GoogleSites; /** - * The sum of squared deviations from the mean of the values in the population. - * For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of - * Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's - * method for accumulating this sum in one pass. If `count` is zero then this - * field must be zero. + * Defaults to an unspecified Workspace type. * - * Uses NSNumber of doubleValue. + * Value: "TYPE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *sumOfSquaredDeviation; - -@end +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1WorkspaceConfig_Type_TypeUnspecified; +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries.metricKind /** - * `BucketOptions` describes the bucket boundaries used to create a histogram - * for the distribution. The buckets can be in a linear sequence, an - * exponential sequence, or each bucket can be specified explicitly. - * `BucketOptions` does not include the number of values in each bucket. A - * bucket has an inclusive lower bound and exclusive upper bound for the values - * that are counted for that bucket. The upper bound of a bucket must be - * strictly greater than the lower bound. The sequence of N buckets for a - * distribution consists of an underflow bucket (number 0), zero or more finite - * buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The - * buckets are contiguous: the lower bound of bucket i (i > 0) is the same as - * the upper bound of bucket i - 1. The buckets span the whole range of finite - * values: lower bound of the underflow bucket is -infinity and the upper bound - * of the overflow bucket is +infinity. The finite buckets are so-called - * because both bounds are finite. + * A value accumulated over a time interval. Cumulative measurements in a time + * series should have the same start time and increasing end times, until an + * event resets the cumulative value to zero and sets a new start time for the + * following points. + * + * Value: "CUMULATIVE" */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptions : GTLRObject - -/** The explicit buckets. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExplicit *explicitBuckets; - -/** The exponential buckets. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExponential *exponentialBuckets; - -/** The linear bucket. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsLinear *linearBuckets; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_Cumulative; /** - * Specifies a set of buckets with arbitrary widths. There are `size(bounds) + - * 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= - * i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` - * field must contain at least one element. If `bounds` has only one element, - * then there are no finite buckets, and that single element is the common - * boundary of the overflow and underflow buckets. + * The change in a value during a time interval. + * + * Value: "DELTA" */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExplicit : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_Delta; /** - * The values must be monotonically increasing. + * An instantaneous measurement of a value. * - * Uses NSNumber of doubleValue. + * Value: "GAUGE" */ -@property(nonatomic, strong, nullable) NSArray *bounds; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_Gauge; /** - * Specifies an exponential sequence of buckets that have a width that is - * proportional to the value of the lower bound. Each bucket represents a - * constant relative uncertainty on a specific value in the bucket. There are - * `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following - * boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower - * bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). + * Do not use this default value. + * + * Value: "METRIC_KIND_UNSPECIFIED" */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExponential : GTLRObject +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_MetricKind_MetricKindUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries.valueType /** - * Must be greater than 1. + * The value is a boolean. This value type can be used only if the metric kind + * is `GAUGE`. * - * Uses NSNumber of doubleValue. + * Value: "BOOL" */ -@property(nonatomic, strong, nullable) NSNumber *growthFactor; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Bool; /** - * Must be greater than 0. + * The value is a `Distribution`. * - * Uses NSNumber of intValue. + * Value: "DISTRIBUTION" */ -@property(nonatomic, strong, nullable) NSNumber *numFiniteBuckets; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Distribution; /** - * Must be greater than 0. + * The value is a double precision floating point number. * - * Uses NSNumber of doubleValue. + * Value: "DOUBLE" */ -@property(nonatomic, strong, nullable) NSNumber *scale; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Double; /** - * Specifies a linear sequence of buckets that all have the same width (except - * overflow and underflow). Each bucket represents a constant absolute - * uncertainty on the specific value in the bucket. There are - * `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following - * boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 - * <= i < N): offset + (width * (i - 1)). + * The value is a signed 64-bit integer. + * + * Value: "INT64" */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsLinear : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Int64; /** - * Must be greater than 0. + * The value is money. * - * Uses NSNumber of intValue. + * Value: "MONEY" */ -@property(nonatomic, strong, nullable) NSNumber *numFiniteBuckets; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_Money; /** - * Lower bound of the first bucket. + * The value is a text string. This value type can be used only if the metric + * kind is `GAUGE`. * - * Uses NSNumber of doubleValue. + * Value: "STRING" */ -@property(nonatomic, strong, nullable) NSNumber *offset; - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_String; /** - * Must be greater than 0. + * Do not use this default value. * - * Uses NSNumber of doubleValue. + * Value: "VALUE_TYPE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *width; - -@end - +FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries_ValueType_ValueTypeUnspecified; /** - * Exemplars are example points that may be used to annotate aggregated - * distribution values. They are metadata that gives information about a - * particular value added to a Distribution bucket, such as a trace ID that was - * active when a value was added. They may contain further information, such as - * a example values and timestamps, origin, etc. + * Information to read/write to blobstore2. */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionExemplar : GTLRObject +@interface GTLRDiscoveryEngine_GdataBlobstore2Info : GTLRObject /** - * Contextual information about the example value. Examples are: Trace: - * type.googleapis.com/google.monitoring.v3.SpanContext Literal string: - * type.googleapis.com/google.protobuf.StringValue Labels dropped during - * aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There - * may be only a single attachment of any given message type in a single - * exemplar, and this is enforced by the system. + * The blob generation id. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *attachments; +@property(nonatomic, strong, nullable) NSNumber *blobGeneration; -/** The observation (sampling) time of the above value. */ -@property(nonatomic, strong, nullable) GTLRDateTime *timestamp; +/** The blob id, e.g., /blobstore/prod/playground/scotty */ +@property(nonatomic, copy, nullable) NSString *blobId; /** - * Value of the exemplar point. This value determines to which bucket the - * exemplar belongs. + * Read handle passed from Bigstore -> Scotty for a GCS download. This is a + * signed, serialized blobstore2.ReadHandle proto which must never be set + * outside of Bigstore, and is not applicable to non-GCS media downloads. * - * Uses NSNumber of doubleValue. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, strong, nullable) NSNumber *value; - -@end +@property(nonatomic, copy, nullable) NSString *downloadReadHandle; +/** + * The blob read token. Needed to read blobs that have not been replicated. + * Might not be available until the final call. + */ +@property(nonatomic, copy, nullable) NSString *readToken; /** - * GTLRDiscoveryEngine_GoogleApiDistributionExemplar_Attachments_Item + * Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a + * signed, serialized blobstore2.BlobMetadataContainer proto which must never + * be consumed outside of Bigstore, and is not applicable to non-GCS media + * uploads. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionExemplar_Attachments_Item : GTLRObject +@property(nonatomic, copy, nullable) NSString *uploadMetadataContainer; + @end /** - * The range of the population values. + * A sequence of media data references representing composite data. Introduced + * to support Bigstore composite objects. For details, visit + * http://go/bigstore-composites. */ -@interface GTLRDiscoveryEngine_GoogleApiDistributionRange : GTLRObject +@interface GTLRDiscoveryEngine_GdataCompositeMedia : GTLRObject /** - * The maximum of the population values. + * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should + * be the byte representation of a blobstore.BlobRef. Since Blobstore is + * deprecating v1, use blobstore2_info instead. For now, any v2 blob will also + * be represented in this field as v1 BlobRef. * - * Uses NSNumber of doubleValue. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, strong, nullable) NSNumber *max; +@property(nonatomic, copy, nullable) NSString *blobRef GTLR_DEPRECATED; /** - * The minimum of the population values. - * - * Uses NSNumber of doubleValue. + * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a + * v2 blob. */ -@property(nonatomic, strong, nullable) NSNumber *min; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataBlobstore2Info *blobstore2Info; /** - * Message that represents an arbitrary HTTP body. It should only be used for - * payload formats that can't be represented as JSON, such as raw binary or an - * HTML page. This message can be used both in streaming and non-streaming API - * methods in the request as well as the response. It can be used as a - * top-level request field, which is convenient if one wants to extract - * parameters from either the URL or HTTP template into the request fields and - * also want access to the raw HTTP body. Example: message GetResourceRequest { - * // A unique request id. string request_id = 1; // The raw HTTP body is bound - * to this field. google.api.HttpBody http_body = 2; } service ResourceService - * { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - * Example with streaming methods: service CaldavService { rpc - * GetCalendar(stream google.api.HttpBody) returns (stream - * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns - * (stream google.api.HttpBody); } Use of this type only changes how the - * request and response bodies are handled, all other features will continue to - * work unchanged. + * A binary data reference for a media download. Serves as a + * technology-agnostic binary reference in some Google infrastructure. This + * value is a serialized storage_cosmo.BinaryReference proto. Storing it as + * bytes is a hack to get around the fact that the cosmo proto (as well as + * others it includes) doesn't support JavaScript. This prevents us from + * including the actual type of this field. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@interface GTLRDiscoveryEngine_GoogleApiHttpBody : GTLRObject +@property(nonatomic, copy, nullable) NSString *cosmoBinaryReference; /** - * The HTTP Content-Type header value specifying the content type of the body. + * crc32.c hash for the payload. + * + * Uses NSNumber of unsignedIntValue. */ -@property(nonatomic, copy, nullable) NSString *contentType; +@property(nonatomic, strong, nullable) NSNumber *crc32cHash; /** - * The HTTP request/response body as raw binary. + * Media data, set if reference_type is INLINE + * + * Remapped to 'inlineProperty' to avoid language reserved word 'inline'. * * Contains encoded binary data; GTLRBase64 can encode/decode (probably * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *data; +@property(nonatomic, copy, nullable) NSString *inlineProperty; /** - * Application specific response metadata. Must be set in the first response - * for streaming APIs. + * Size of the data, in bytes + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *extensions; - -@end - +@property(nonatomic, strong, nullable) NSNumber *length; /** - * GTLRDiscoveryEngine_GoogleApiHttpBody_Extensions_Item + * MD5 hash for the payload. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@interface GTLRDiscoveryEngine_GoogleApiHttpBody_Extensions_Item : GTLRObject -@end +@property(nonatomic, copy, nullable) NSString *md5Hash; +/** Reference to a TI Blob, set if reference_type is BIGSTORE_REF. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataObjectId *objectId; -/** - * A specific metric, identified by specifying values for all of the labels of - * a `MetricDescriptor`. - */ -@interface GTLRDiscoveryEngine_GoogleApiMetric : GTLRObject +/** Path to the data, set if reference_type is PATH */ +@property(nonatomic, copy, nullable) NSString *path; /** - * The set of label values that uniquely identify this metric. All labels - * listed in the `MetricDescriptor` must be assigned values. + * Describes what the field reference contains. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_BigstoreRef + * Reference points to a bigstore object (Value: "BIGSTORE_REF") + * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_BlobRef + * Reference points to a blobstore object. This could be either a v1 + * blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info + * first, since v1 is being deprecated. (Value: "BLOB_REF") + * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_CosmoBinaryReference + * Indicates the data is stored in cosmo_binary_reference. (Value: + * "COSMO_BINARY_REFERENCE") + * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_Inline Data + * is included into this proto buffer (Value: "INLINE") + * @arg @c kGTLRDiscoveryEngine_GdataCompositeMedia_ReferenceType_Path + * Reference contains a GFS path or a local path. (Value: "PATH") */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMetric_Labels *labels; +@property(nonatomic, copy, nullable) NSString *referenceType; /** - * An existing metric type, see google.api.MetricDescriptor. For example, - * `custom.googleapis.com/invoice/paid/amount`. + * SHA-1 hash for the payload. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *type; +@property(nonatomic, copy, nullable) NSString *sha1Hash; @end /** - * The set of label values that uniquely identify this metric. All labels - * listed in the `MetricDescriptor` must be assigned values. - * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Detailed Content-Type information from Scotty. The Content-Type of the media + * will typically be filled in by the header or Scotty's best_guess, but this + * extended information provides the backend with more information so that it + * can make a better decision if needed. This is only used on media upload + * requests from Scotty. */ -@interface GTLRDiscoveryEngine_GoogleApiMetric_Labels : GTLRObject -@end +@interface GTLRDiscoveryEngine_GdataContentTypeInfo : GTLRObject +/** Scotty's best guess of what the content type of the file is. */ +@property(nonatomic, copy, nullable) NSString *bestGuess; /** - * An object representing a resource that can be used for monitoring, logging, - * billing, or other purposes. Examples include virtual machine instances, - * databases, and storage devices such as disks. The `type` field identifies a - * MonitoredResourceDescriptor object that describes the resource's schema. - * Information in the `labels` field identifies the actual resource and its - * attributes according to the schema. For example, a particular Compute Engine - * VM instance could be represented by the following object, because the - * MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, - * `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { - * "project_id": "my-project", "instance_id": "12345678901234", "zone": - * "us-central1-a" }} + * The content type of the file derived by looking at specific bytes (i.e. + * "magic bytes") of the actual file. */ -@interface GTLRDiscoveryEngine_GoogleApiMonitoredResource : GTLRObject +@property(nonatomic, copy, nullable) NSString *fromBytes; /** - * Required. Values for all of the labels listed in the associated monitored - * resource descriptor. For example, Compute Engine VM instances use the labels - * `"project_id"`, `"instance_id"`, and `"zone"`. + * The content type of the file derived from the file extension of the original + * file name used by the client. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMonitoredResource_Labels *labels; +@property(nonatomic, copy, nullable) NSString *fromFileName; /** - * Required. The monitored resource type. This field must match the `type` - * field of a MonitoredResourceDescriptor object. For example, the type of a - * Compute Engine VM instance is `gce_instance`. Some descriptors include the - * service name in the type; for example, the type of a Datastream stream is - * `datastream.googleapis.com/Stream`. + * The content type of the file as specified in the request headers, multipart + * headers, or RUPIO start request. */ -@property(nonatomic, copy, nullable) NSString *type; +@property(nonatomic, copy, nullable) NSString *fromHeader; + +/** + * The content type of the file derived from the file extension of the URL + * path. The URL path is assumed to represent a file name (which is typically + * only true for agents that are providing a REST API). + */ +@property(nonatomic, copy, nullable) NSString *fromUrlPath; @end /** - * Required. Values for all of the labels listed in the associated monitored - * resource descriptor. For example, Compute Engine VM instances use the labels - * `"project_id"`, `"instance_id"`, and `"zone"`. - * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Backend response for a Diff get checksums response. For details on the + * Scotty Diff protocol, visit http://go/scotty-diff-protocol. */ -@interface GTLRDiscoveryEngine_GoogleApiMonitoredResource_Labels : GTLRObject -@end +@interface GTLRDiscoveryEngine_GdataDiffChecksumsResponse : GTLRObject +/** + * Exactly one of these fields must be populated. If checksums_location is + * filled, the server will return the corresponding contents to the user. If + * object_location is filled, the server will calculate the checksums based on + * the content there and return that to the user. For details on the format of + * the checksums, see http://go/scotty-diff-protocol. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *checksumsLocation; /** - * Auxiliary metadata for a MonitoredResource object. MonitoredResource objects - * contain the minimum set of information to uniquely identify a monitored - * resource instance. There is some other useful auxiliary metadata. Monitoring - * and Logging use an ingestion pipeline to extract metadata for cloud - * resources of all types, and store the metadata in this message. + * The chunk size of checksums. Must be a multiple of 256KB. + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *chunkSizeBytes; /** - * Output only. Values for predefined system metadata labels. System labels are - * a kind of metadata extracted by Google, including "machine_image", "vpc", - * "subnet_id", "security_group", "name", etc. System label values can be only - * strings, Boolean values, or a list of strings. For example: { "name": - * "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": - * false } + * If set, calculate the checksums based on the contents and return them to the + * caller. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_SystemLabels *systemLabels; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *objectLocation; -/** Output only. A map of user-defined metadata labels. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_UserLabels *userLabels; +/** + * The total size of the server object. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *objectSizeBytes; + +/** The object version of the object the checksums are being returned for. */ +@property(nonatomic, copy, nullable) NSString *objectVersion; @end /** - * Output only. Values for predefined system metadata labels. System labels are - * a kind of metadata extracted by Google, including "machine_image", "vpc", - * "subnet_id", "security_group", "name", etc. System label values can be only - * strings, Boolean values, or a list of strings. For example: { "name": - * "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": - * false } - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Backend response for a Diff download response. For details on the Scotty + * Diff protocol, visit http://go/scotty-diff-protocol. */ -@interface GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_SystemLabels : GTLRObject +@interface GTLRDiscoveryEngine_GdataDiffDownloadResponse : GTLRObject + +/** The original object location. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *objectLocation; + @end /** - * Output only. A map of user-defined metadata labels. - * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * A Diff upload request. For details on the Scotty Diff protocol, visit + * http://go/scotty-diff-protocol. */ -@interface GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_UserLabels : GTLRObject -@end - +@interface GTLRDiscoveryEngine_GdataDiffUploadRequest : GTLRObject /** - * The error payload that is populated on LRO sync APIs, including the - * following: * - * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` - * * - * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun` + * The location of the checksums for the new object. Agents must clone the + * object located here, as the upload server will delete the contents once a + * response is received. For details on the format of the checksums, see + * http://go/scotty-diff-protocol. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *checksumsInfo; /** - * The full resource name of the Connector Run. Format: `projects/ * - * /locations/ * /collections/ * /dataConnector/connectorRuns/ *`. The - * `connector_run_id` is system-generated. + * The location of the new object. Agents must clone the object located here, + * as the upload server will delete the contents once a response is received. */ -@property(nonatomic, copy, nullable) NSString *connectorRun; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *objectInfo; /** - * The full resource name of the DataConnector. Format: `projects/ * - * /locations/ * /collections/ * /dataConnector`. + * The object version of the object that is the base version the incoming diff + * script will be applied to. This field will always be filled in. */ -@property(nonatomic, copy, nullable) NSString *dataConnector; +@property(nonatomic, copy, nullable) NSString *objectVersion; -/** The time when the connector run ended. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +@end -/** The entity to sync for the connector run. */ -@property(nonatomic, copy, nullable) NSString *entity; -/** The operation resource name of the LRO to sync the connector. */ -@property(nonatomic, copy, nullable) NSString *operation; +/** + * Backend response for a Diff upload request. For details on the Scotty Diff + * protocol, visit http://go/scotty-diff-protocol. + */ +@interface GTLRDiscoveryEngine_GdataDiffUploadResponse : GTLRObject -/** The time when the connector run started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** + * The object version of the object at the server. Must be included in the end + * notification response. The version in the end notification response must + * correspond to the new version of the object that is now stored at the + * server, after the upload. + */ +@property(nonatomic, copy, nullable) NSString *objectVersion; /** - * The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL` + * The location of the original file for a diff upload request. Must be filled + * in if responding to an upload start notification. */ -@property(nonatomic, copy, nullable) NSString *syncType; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataCompositeMedia *originalObject; @end /** - * A description of the context in which an error occurred. + * Backend response for a Diff get version response. For details on the Scotty + * Diff protocol, visit http://go/scotty-diff-protocol. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorContext : GTLRObject - -/** The HTTP request which was processed when the error was triggered. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingHttpRequestContext *httpRequest; +@interface GTLRDiscoveryEngine_GdataDiffVersionResponse : GTLRObject /** - * The location in the source code where the decision was made to report the - * error, usually the place where it was logged. + * The total size of the server object. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingSourceLocation *reportLocation; +@property(nonatomic, strong, nullable) NSNumber *objectSizeBytes; + +/** The version of the object stored at the server. */ +@property(nonatomic, copy, nullable) NSString *objectVersion; @end /** - * An error log which is reported to the Error Reporting system. + * Parameters specific to media downloads. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog : GTLRObject - -/** The error payload that is populated on LRO connector sync APIs. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext *connectorRunPayload; - -/** A description of the context in which the error occurred. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorContext *context; - -/** The error payload that is populated on LRO import APIs. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingImportErrorContext *importPayload; - -/** A message describing the error. */ -@property(nonatomic, copy, nullable) NSString *message; +@interface GTLRDiscoveryEngine_GdataDownloadParameters : GTLRObject /** - * The API request payload, represented as a protocol buffer. Most API request - * types are supported—for example: * - * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` - * * - * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` + * A boolean to be returned in the response to Scotty. Allows/disallows gzip + * encoding of the payload content when the server thinks it's advantageous + * (hence, does not guarantee compression) which allows Scotty to GZip the + * response to the client. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_RequestPayload *requestPayload; +@property(nonatomic, strong, nullable) NSNumber *allowGzipCompression; /** - * The API response payload, represented as a protocol buffer. This is used to - * log some "soft errors", where the response is valid but we consider there - * are some quality issues like unjoined events. The following API responses - * are supported, and no PII is included: * - * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * - * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * - * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` + * Determining whether or not Apiary should skip the inclusion of any + * Content-Range header on its response to Scotty. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_ResponsePayload *responsePayload; - -/** The service context in which this error has occurred. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingServiceContext *serviceContext; - -/** The RPC status associated with the error log. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *status; +@property(nonatomic, strong, nullable) NSNumber *ignoreRange; @end /** - * The API request payload, represented as a protocol buffer. Most API request - * types are supported—for example: * - * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` - * * - * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * A reference to data stored on the filesystem, on GFS or in blobstore. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_RequestPayload : GTLRObject -@end - +@interface GTLRDiscoveryEngine_GdataMedia : GTLRObject /** - * The API response payload, represented as a protocol buffer. This is used to - * log some "soft errors", where the response is valid but we consider there - * are some quality issues like unjoined events. The following API responses - * are supported, and no PII is included: * - * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * - * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * - * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Deprecated, use one of explicit hash type fields instead. Algorithm used for + * calculating the hash. As of 2011/01/21, "MD5" is the only possible value for + * this field. New values may be added at any time. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_ResponsePayload : GTLRObject -@end - +@property(nonatomic, copy, nullable) NSString *algorithm GTLR_DEPRECATED; /** - * HTTP request data that is related to a reported error. + * Use object_id instead. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingHttpRequestContext : GTLRObject +@property(nonatomic, copy, nullable) NSString *bigstoreObjectRef GTLR_DEPRECATED; /** - * The HTTP response status code for the request. + * Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should + * be the byte representation of a blobstore.BlobRef. Since Blobstore is + * deprecating v1, use blobstore2_info instead. For now, any v2 blob will also + * be represented in this field as v1 BlobRef. * - * Uses NSNumber of intValue. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, strong, nullable) NSNumber *responseStatusCode; - -@end +@property(nonatomic, copy, nullable) NSString *blobRef GTLR_DEPRECATED; +/** + * Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a + * v2 blob. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataBlobstore2Info *blobstore2Info; /** - * The error payload that is populated on LRO import APIs, including the - * following: * - * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * - * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` + * A composite media composed of one or more media objects, set if + * reference_type is COMPOSITE_MEDIA. The media length field must be set to the + * sum of the lengths of all composite media objects. Note: All composite media + * must have length specified. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingImportErrorContext : GTLRObject +@property(nonatomic, strong, nullable) NSArray *compositeMedia; -/** The detailed content which caused the error on importing a document. */ -@property(nonatomic, copy, nullable) NSString *document; +/** MIME type of the data */ +@property(nonatomic, copy, nullable) NSString *contentType; + +/** Extended content type information provided for Scotty uploads. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataContentTypeInfo *contentTypeInfo; /** - * Google Cloud Storage file path of the import source. Can be set for batch - * operation error. + * A binary data reference for a media download. Serves as a + * technology-agnostic binary reference in some Google infrastructure. This + * value is a serialized storage_cosmo.BinaryReference proto. Storing it as + * bytes is a hack to get around the fact that the cosmo proto (as well as + * others it includes) doesn't support JavaScript. This prevents us from + * including the actual type of this field. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *gcsPath; +@property(nonatomic, copy, nullable) NSString *cosmoBinaryReference; /** - * Line number of the content in file. Should be empty for permission or batch - * operation error. + * For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: + * (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash + * provided by the agent to be used to verify the data being downloaded. + * Currently only supported for inline payloads. Further, only crc32c_hash is + * currently supported. + * + * Uses NSNumber of unsignedIntValue. */ -@property(nonatomic, copy, nullable) NSString *lineNumber; - -/** The operation resource name of the LRO. */ -@property(nonatomic, copy, nullable) NSString *operation; +@property(nonatomic, strong, nullable) NSNumber *crc32cHash; -/** The detailed content which caused the error on importing a user event. */ -@property(nonatomic, copy, nullable) NSString *userEvent; +/** Set if reference_type is DIFF_CHECKSUMS_RESPONSE. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffChecksumsResponse *diffChecksumsResponse; -@end +/** Set if reference_type is DIFF_DOWNLOAD_RESPONSE. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffDownloadResponse *diffDownloadResponse; +/** Set if reference_type is DIFF_UPLOAD_REQUEST. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffUploadRequest *diffUploadRequest; -/** - * Describes a running service that sends errors. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingServiceContext : GTLRObject +/** Set if reference_type is DIFF_UPLOAD_RESPONSE. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffUploadResponse *diffUploadResponse; -/** - * An identifier of the service—for example, `discoveryengine.googleapis.com`. - */ -@property(nonatomic, copy, nullable) NSString *service; +/** Set if reference_type is DIFF_VERSION_RESPONSE. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDiffVersionResponse *diffVersionResponse; -@end +/** Parameters for a media download. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataDownloadParameters *downloadParameters; +/** Original file name */ +@property(nonatomic, copy, nullable) NSString *filename; /** - * Indicates a location in the source code of the service for which errors are - * reported. + * Deprecated, use one of explicit hash type fields instead. These two hash + * related fields will only be populated on Scotty based media uploads and will + * contain the content of the hash group in the NotificationRequest: + * http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash + * Hex encoded hash value of the uploaded media. + * + * Remapped to 'hashProperty' to avoid NSObject's 'hash'. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingSourceLocation : GTLRObject +@property(nonatomic, copy, nullable) NSString *hashProperty GTLR_DEPRECATED; /** - * Human-readable name of a function or method—for example, - * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. + * For Scotty uploads only. If a user sends a hash code and the backend has + * requested that Scotty verify the upload against the client hash, Scotty will + * perform the check on behalf of the backend and will reject it if the hashes + * don't match. This is set to true if Scotty performed this verification. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *functionName; - -@end - +@property(nonatomic, strong, nullable) NSNumber *hashVerified; /** - * Access Control Configuration. + * Media data, set if reference_type is INLINE + * + * Remapped to 'inlineProperty' to avoid language reserved word 'inline'. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AclConfig : GTLRObject - -/** Identity provider config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig *idpConfig; +@property(nonatomic, copy, nullable) NSString *inlineProperty; /** - * Immutable. The full resource name of the acl configuration. Format: - * `projects/{project}/locations/{location}/aclConfig`. This field must be a - * UTF-8 encoded string with a length limit of 1024 characters. + * |is_potential_retry| is set false only when Scotty is certain that it has + * not sent the request before. When a client resumes an upload, this field + * must be set true in agent calls, because Scotty cannot be certain that it + * has never sent the request before due to potential failure in the session + * state persistence. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *name; - -@end - +@property(nonatomic, strong, nullable) NSNumber *isPotentialRetry; /** - * Request message for CompletionService.AdvancedCompleteQuery method. . + * Size of the data, in bytes + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest : GTLRObject - -/** Optional. Specification to boost suggestions matching the condition. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec *boostSpec; - -/** Optional. Experiment ids for this request. */ -@property(nonatomic, strong, nullable) NSArray *experimentIds; +@property(nonatomic, strong, nullable) NSNumber *length; /** - * Indicates if tail suggestions should be returned if there are no suggestions - * that match the full query. Even if set to true, if there are suggestions - * that match the full query, those are returned and no tail suggestions are - * returned. + * Scotty-provided MD5 hash for an upload. * - * Uses NSNumber of boolValue. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, strong, nullable) NSNumber *includeTailSuggestions; +@property(nonatomic, copy, nullable) NSString *md5Hash; /** - * Required. The typeahead input used to fetch suggestions. Maximum length is - * 128 characters. The query can not be empty for most of the suggestion types. - * If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is - * when the suggestion_types contains only the type `RECENT_SEARCH`, the query - * can be an empty string. The is called "zero prefix" feature, which returns - * user's recently searched queries given the empty query. + * Media id to forward to the operation GetMedia. Can be set if reference_type + * is GET_MEDIA. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *query; +@property(nonatomic, copy, nullable) NSString *mediaId; -/** - * Specifies the autocomplete query model, which only applies to the QUERY - * SuggestionType. This overrides any model specified in the Configuration > - * Autocomplete section of the Cloud console. Currently supported values: * - * `document` - Using suggestions generated from user-imported documents. * - * `search-history` - Using suggestions generated from the past history of - * SearchService.Search API calls. Do not use it when there is no traffic for - * Search API. * `user-event` - Using suggestions generated from user-imported - * search events. * `document-completable` - Using suggestions taken directly - * from user-imported document fields marked as completable. Default values: * - * `document` is the default model for regular dataStores. * `search-history` - * is the default model for site search dataStores. - */ -@property(nonatomic, copy, nullable) NSString *queryModel; - -/** - * Optional. Suggestion types to return. If empty or unspecified, query - * suggestions are returned. Only one suggestion type is supported at the - * moment. - */ -@property(nonatomic, strong, nullable) NSArray *suggestionTypes; +/** Reference to a TI Blob, set if reference_type is BIGSTORE_REF. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GdataObjectId *objectId; -/** Optional. Specification of each suggestion type. */ -@property(nonatomic, strong, nullable) NSArray *suggestionTypeSpecs; +/** Path to the data, set if reference_type is PATH */ +@property(nonatomic, copy, nullable) NSString *path; /** - * Optional. Information about the end user. This should be the same identifier - * information as UserEvent.user_info and SearchRequest.user_info. + * Describes what the field reference contains. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_ArbitraryBytes + * Informs Scotty to generate a response payload with the size specified + * in the length field. The contents of the payload are generated by + * Scotty and are undefined. This is useful for testing download speeds + * between the user and Scotty without involving a real payload source. + * Note: range is not supported when using arbitrary_bytes. (Value: + * "ARBITRARY_BYTES") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_BigstoreRef + * Reference points to a bigstore object (Value: "BIGSTORE_REF") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_BlobRef Reference + * points to a blobstore object. This could be either a v1 blob_ref or a + * v2 blobstore2_info. Clients should check blobstore2_info first, since + * v1 is being deprecated. (Value: "BLOB_REF") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_CompositeMedia The + * content for this media object is stored across multiple partial media + * objects under the composite_media field. (Value: "COMPOSITE_MEDIA") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_CosmoBinaryReference + * Indicates the data is stored in cosmo_binary_reference. (Value: + * "COSMO_BINARY_REFERENCE") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffChecksumsResponse + * Indicates the data is stored in diff_checksums_response. (Value: + * "DIFF_CHECKSUMS_RESPONSE") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffDownloadResponse + * Indicates the data is stored in diff_download_response. (Value: + * "DIFF_DOWNLOAD_RESPONSE") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffUploadRequest + * Indicates the data is stored in diff_upload_request. (Value: + * "DIFF_UPLOAD_REQUEST") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffUploadResponse + * Indicates the data is stored in diff_upload_response. (Value: + * "DIFF_UPLOAD_RESPONSE") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_DiffVersionResponse + * Indicates the data is stored in diff_version_response. (Value: + * "DIFF_VERSION_RESPONSE") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_GetMedia Data should + * be accessed from the current service using the operation GetMedia. + * (Value: "GET_MEDIA") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_Inline Data is + * included into this proto buffer (Value: "INLINE") + * @arg @c kGTLRDiscoveryEngine_GdataMedia_ReferenceType_Path Reference + * contains a GFS path or a local path. (Value: "PATH") */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserInfo *userInfo; +@property(nonatomic, copy, nullable) NSString *referenceType; /** - * A unique identifier for tracking visitors. For example, this could be - * implemented with an HTTP cookie, which should be able to uniquely identify a - * visitor on a single device. This unique identifier should not change if the - * visitor logs in or out of the website. This field should NOT have a fixed - * value such as `unknown_visitor`. This should be the same identifier as - * UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be - * a UTF-8 encoded string with a length limit of 128 + * Scotty-provided SHA1 hash for an upload. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *userPseudoId; - -@end - +@property(nonatomic, copy, nullable) NSString *sha1Hash; /** - * Specification to boost suggestions based on the condtion of the suggestion. + * Scotty-provided SHA256 hash for an upload. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *sha256Hash; /** - * Condition boost specifications. If a suggestion matches multiple conditions - * in the specifications, boost values from these specifications are all - * applied and combined in a non-linear way. Maximum number of specifications - * is 20. Note: Currently only support language condition boost. + * Time at which the media data was last updated, in milliseconds since UNIX + * epoch + * + * Uses NSNumber of unsignedLongLongValue. */ -@property(nonatomic, strong, nullable) NSArray *conditionBoostSpecs; +@property(nonatomic, strong, nullable) NSNumber *timestamp; + +/** A unique fingerprint/version id for the media data */ +@property(nonatomic, copy, nullable) NSString *token; @end /** - * Boost applies to suggestions which match a condition. + * This is a copy of the tech.blob.ObjectId proto, which could not be used + * directly here due to transitive closure issues with JavaScript support; see + * http://b/8801763. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec : GTLRObject +@interface GTLRDiscoveryEngine_GdataObjectId : GTLRObject + +/** The name of the bucket to which this object belongs. */ +@property(nonatomic, copy, nullable) NSString *bucketName; /** - * Strength of the boost, which should be in [-1, 1]. Negative boost means - * demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big - * promotion. However, it does not necessarily mean that the top result will be - * a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. - * However, other suggestions that are relevant might still be shown. Setting - * to 0.0 means no boost applied. The boosting condition is ignored. + * Generation of the object. Generations are monotonically increasing across + * writes, allowing them to be be compared to determine which generation is + * newer. If this is omitted in a request, then you are requesting the live + * object. See http://go/bigstore-versions * - * Uses NSNumber of floatValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *boost; +@property(nonatomic, strong, nullable) NSNumber *generation; -/** - * An expression which specifies a boost condition. The syntax is the same as - * [filter expression - * syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). - * Currently, the only supported condition is a list of BCP-47 lang codes. - * Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: - * ANY("en", "fr"))` - */ -@property(nonatomic, copy, nullable) NSString *condition; +/** The name of the object. */ +@property(nonatomic, copy, nullable) NSString *objectName; @end /** - * Specification of each suggestion type. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec : GTLRObject - -/** - * Optional. Maximum number of suggestions to return for each suggestion type. - * - * Uses NSNumber of intValue. + * `Distribution` contains summary statistics for a population of values. It + * optionally contains a histogram representing the distribution of those + * values across a set of buckets. The summary statistics are the count, mean, + * sum of the squared deviation from the mean, the minimum, and the maximum of + * the set of population of values. The histogram is based on a sequence of + * buckets and gives a count of values that fall into each bucket. The + * boundaries of the buckets are given either explicitly or by formulas for + * buckets of fixed or exponentially increasing widths. Although it is not + * forbidden, it is generally a bad idea to include non-finite values + * (infinities or NaNs) in the population of values, as this will render the + * `mean` and `sum_of_squared_deviation` fields meaningless. */ -@property(nonatomic, strong, nullable) NSNumber *maxSuggestions; +@interface GTLRDiscoveryEngine_GoogleApiDistribution : GTLRObject /** - * Optional. Suggestion type. + * The number of values in each bucket of the histogram, as described in + * `bucket_options`. If the distribution does not have a histogram, then omit + * this field. If there is a histogram, then the sum of the values in + * `bucket_counts` must equal the value in the `count` field of the + * distribution. If present, `bucket_counts` should contain N values, where N + * is the number of buckets specified in `bucket_options`. If you supply fewer + * than N values, the remaining values are assumed to be 0. The order of the + * values in `bucket_counts` follows the bucket numbering schemes described for + * the three bucket types. The first value must be the count for the underflow + * bucket (number 0). The next N-2 values are the counts for the finite buckets + * (number 1 through N-2). The N'th value in `bucket_counts` is the count for + * the overflow bucket (number N-1). * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_Content - * Returns content suggestions. (Value: "CONTENT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_GoogleWorkspace - * Returns Google Workspace suggestions. (Value: "GOOGLE_WORKSPACE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_People - * Returns people suggestions. (Value: "PEOPLE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_Query - * Returns query suggestions. (Value: "QUERY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_RecentSearch - * Returns recent search suggestions. (Value: "RECENT_SEARCH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_SuggestionTypeUnspecified - * Default value. (Value: "SUGGESTION_TYPE_UNSPECIFIED") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *suggestionType; - -@end - +@property(nonatomic, strong, nullable) NSArray *bucketCounts; /** - * Response message for CompletionService.AdvancedCompleteQuery method. + * Defines the histogram bucket boundaries. If the distribution does not + * contain a histogram, then omit this field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptions *bucketOptions; /** - * Results of the matched content suggestions. The result list is ordered and - * the first result is the top suggestion. + * The number of values in the population. Must be non-negative. This value + * must equal the sum of the values in `bucket_counts` if a histogram is + * provided. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *contentSuggestions; +@property(nonatomic, strong, nullable) NSNumber *count; -/** - * Results of the matched people suggestions. The result list is ordered and - * the first result is the top suggestion. - */ -@property(nonatomic, strong, nullable) NSArray *peopleSuggestions; +/** Must be in increasing order of `value` field. */ +@property(nonatomic, strong, nullable) NSArray *exemplars; /** - * Results of the matched query suggestions. The result list is ordered and the - * first result is a top suggestion. + * The arithmetic mean of the values in the population. If `count` is zero then + * this field must be zero. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSArray *querySuggestions; +@property(nonatomic, strong, nullable) NSNumber *mean; /** - * Results of the matched "recent search" suggestions. The result list is - * ordered and the first result is the top suggestion. + * If specified, contains the range of the population values. The field must + * not be present if the `count` is zero. */ -@property(nonatomic, strong, nullable) NSArray *recentSearchSuggestions; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionRange *range; /** - * True if the returned suggestions are all tail suggestions. For tail matching - * to be triggered, include_tail_suggestions in the request must be true and - * there must be no suggestions that match the full query. + * The sum of squared deviations from the mean of the values in the population. + * For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of + * Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's + * method for accumulating this sum in one pass. If `count` is zero then this + * field must be zero. * - * Uses NSNumber of boolValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *tailMatchTriggered; +@property(nonatomic, strong, nullable) NSNumber *sumOfSquaredDeviation; @end /** - * Suggestions as content. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion : GTLRObject - -/** - * The type of the content suggestion. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion_ContentType_ContentTypeUnspecified - * Default value. (Value: "CONTENT_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion_ContentType_GoogleWorkspace - * The suggestion is from a Google Workspace source. (Value: - * "GOOGLE_WORKSPACE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion_ContentType_ThirdParty - * The suggestion is from a third party source. (Value: "THIRD_PARTY") + * `BucketOptions` describes the bucket boundaries used to create a histogram + * for the distribution. The buckets can be in a linear sequence, an + * exponential sequence, or each bucket can be specified explicitly. + * `BucketOptions` does not include the number of values in each bucket. A + * bucket has an inclusive lower bound and exclusive upper bound for the values + * that are counted for that bucket. The upper bound of a bucket must be + * strictly greater than the lower bound. The sequence of N buckets for a + * distribution consists of an underflow bucket (number 0), zero or more finite + * buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The + * buckets are contiguous: the lower bound of bucket i (i > 0) is the same as + * the upper bound of bucket i - 1. The buckets span the whole range of finite + * values: lower bound of the underflow bucket is -infinity and the upper bound + * of the overflow bucket is +infinity. The finite buckets are so-called + * because both bounds are finite. */ -@property(nonatomic, copy, nullable) NSString *contentType; +@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptions : GTLRObject -/** The name of the dataStore that this suggestion belongs to. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +/** The explicit buckets. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExplicit *explicitBuckets; + +/** The exponential buckets. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExponential *exponentialBuckets; + +/** The linear bucket. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsLinear *linearBuckets; + +@end -/** The destination uri of the content suggestion. */ -@property(nonatomic, copy, nullable) NSString *destinationUri; /** - * The document data snippet in the suggestion. Only a subset of fields will be - * populated. + * Specifies a set of buckets with arbitrary widths. There are `size(bounds) + + * 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= + * i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` + * field must contain at least one element. If `bounds` has only one element, + * then there are no finite buckets, and that single element is the common + * boundary of the overflow and underflow buckets. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document *document; - -/** The icon uri of the content suggestion. */ -@property(nonatomic, copy, nullable) NSString *iconUri; +@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExplicit : GTLRObject /** - * The score of each suggestion. The score is in the range of [0, 1]. + * The values must be monotonically increasing. * * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *score; - -/** The suggestion for the query. */ -@property(nonatomic, copy, nullable) NSString *suggestion; +@property(nonatomic, strong, nullable) NSArray *bounds; @end /** - * Suggestions as people. + * Specifies an exponential sequence of buckets that have a width that is + * proportional to the value of the lower bound. Each bucket represents a + * constant relative uncertainty on a specific value in the bucket. There are + * `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following + * boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower + * bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion : GTLRObject - -/** The name of the dataStore that this suggestion belongs to. */ -@property(nonatomic, copy, nullable) NSString *dataStore; - -/** The destination uri of the person suggestion. */ -@property(nonatomic, copy, nullable) NSString *destinationUri; - -/** The photo uri of the person suggestion. */ -@property(nonatomic, copy, nullable) NSString *displayPhotoUri; +@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsExponential : GTLRObject /** - * The document data snippet in the suggestion. Only a subset of fields is - * populated. + * Must be greater than 1. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document *document; +@property(nonatomic, strong, nullable) NSNumber *growthFactor; /** - * The type of the person. + * Must be greater than 0. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_CloudIdentity - * The suggestion is from a GOOGLE_IDENTITY source. (Value: - * "CLOUD_IDENTITY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_PersonTypeUnspecified - * Default value. (Value: "PERSON_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_ThirdPartyIdentity - * The suggestion is from a THIRD_PARTY_IDENTITY source. (Value: - * "THIRD_PARTY_IDENTITY") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *personType; +@property(nonatomic, strong, nullable) NSNumber *numFiniteBuckets; /** - * The score of each suggestion. The score is in the range of [0, 1]. + * Must be greater than 0. * * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *score; - -/** The suggestion for the query. */ -@property(nonatomic, copy, nullable) NSString *suggestion; +@property(nonatomic, strong, nullable) NSNumber *scale; @end /** - * Suggestions as search queries. + * Specifies a linear sequence of buckets that all have the same width (except + * overflow and underflow). Each bucket represents a constant absolute + * uncertainty on the specific value in the bucket. There are + * `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following + * boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 + * <= i < N): offset + (width * (i - 1)). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiDistributionBucketOptionsLinear : GTLRObject /** - * The unique document field paths that serve as the source of this suggestion - * if it was generated from completable fields. This field is only populated - * for the document-completable model. + * Must be greater than 0. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSArray *completableFieldPaths; - -/** The name of the dataStore that this suggestion belongs to. */ -@property(nonatomic, strong, nullable) NSArray *dataStore; +@property(nonatomic, strong, nullable) NSNumber *numFiniteBuckets; /** - * The score of each suggestion. The score is in the range of [0, 1]. + * Lower bound of the first bucket. * * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *score; +@property(nonatomic, strong, nullable) NSNumber *offset; -/** The suggestion for the query. */ -@property(nonatomic, copy, nullable) NSString *suggestion; +/** + * Must be greater than 0. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *width; @end /** - * Suggestions from recent search history. + * Exemplars are example points that may be used to annotate aggregated + * distribution values. They are metadata that gives information about a + * particular value added to a Distribution bucket, such as a trace ID that was + * active when a value was added. They may contain further information, such as + * a example values and timestamps, origin, etc. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiDistributionExemplar : GTLRObject -/** The time when this recent rearch happened. */ -@property(nonatomic, strong, nullable) GTLRDateTime *recentSearchTime; +/** + * Contextual information about the example value. Examples are: Trace: + * type.googleapis.com/google.monitoring.v3.SpanContext Literal string: + * type.googleapis.com/google.protobuf.StringValue Labels dropped during + * aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There + * may be only a single attachment of any given message type in a single + * exemplar, and this is enforced by the system. + */ +@property(nonatomic, strong, nullable) NSArray *attachments; + +/** The observation (sampling) time of the above value. */ +@property(nonatomic, strong, nullable) GTLRDateTime *timestamp; /** - * The score of each suggestion. The score is in the range of [0, 1]. + * Value of the exemplar point. This value determines to which bucket the + * exemplar belongs. * * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *score; +@property(nonatomic, strong, nullable) NSNumber *value; + +@end -/** The suggestion for the query. */ -@property(nonatomic, copy, nullable) NSString *suggestion; +/** + * GTLRDiscoveryEngine_GoogleApiDistributionExemplar_Attachments_Item + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleApiDistributionExemplar_Attachments_Item : GTLRObject @end /** - * Configuration data for advance site search. + * The range of the population values. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiDistributionRange : GTLRObject /** - * If set true, automatic refresh is disabled for the DataStore. + * The maximum of the population values. * - * Uses NSNumber of boolValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *disableAutomaticRefresh; +@property(nonatomic, strong, nullable) NSNumber *max; /** - * If set true, initial indexing is disabled for the DataStore. + * The minimum of the population values. * - * Uses NSNumber of boolValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *disableInitialIndex; +@property(nonatomic, strong, nullable) NSNumber *min; @end /** - * AlloyDB source import data from. + * Message that represents an arbitrary HTTP body. It should only be used for + * payload formats that can't be represented as JSON, such as raw binary or an + * HTML page. This message can be used both in streaming and non-streaming API + * methods in the request as well as the response. It can be used as a + * top-level request field, which is convenient if one wants to extract + * parameters from either the URL or HTTP template into the request fields and + * also want access to the raw HTTP body. Example: message GetResourceRequest { + * // A unique request id. string request_id = 1; // The raw HTTP body is bound + * to this field. google.api.HttpBody http_body = 2; } service ResourceService + * { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + * Example with streaming methods: service CaldavService { rpc + * GetCalendar(stream google.api.HttpBody) returns (stream + * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns + * (stream google.api.HttpBody); } Use of this type only changes how the + * request and response bodies are handled, all other features will continue to + * work unchanged. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlloyDbSource : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiHttpBody : GTLRObject /** - * Required. The AlloyDB cluster to copy the data from with a length limit of - * 256 characters. + * The HTTP Content-Type header value specifying the content type of the body. */ -@property(nonatomic, copy, nullable) NSString *clusterId; +@property(nonatomic, copy, nullable) NSString *contentType; /** - * Required. The AlloyDB database to copy the data from with a length limit of - * 256 characters. + * The HTTP request/response body as raw binary. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *databaseId; +@property(nonatomic, copy, nullable) NSString *data; /** - * Intermediate Cloud Storage directory used for the import with a length limit - * of 2,000 characters. Can be specified if one wants to have the AlloyDB - * export to a specific Cloud Storage directory. Ensure that the AlloyDB - * service account has the necessary Cloud Storage Admin permissions to access - * the specified Cloud Storage directory. + * Application specific response metadata. Must be set in the first response + * for streaming APIs. */ -@property(nonatomic, copy, nullable) NSString *gcsStagingDir; +@property(nonatomic, strong, nullable) NSArray *extensions; -/** - * Required. The AlloyDB location to copy the data from with a length limit of - * 256 characters. - */ -@property(nonatomic, copy, nullable) NSString *locationId; +@end -/** - * The project ID that contains the AlloyDB source. Has a length limit of 128 - * characters. If not specified, inherits the project ID from the parent - * request. - */ -@property(nonatomic, copy, nullable) NSString *projectId; /** - * Required. The AlloyDB table to copy the data from with a length limit of 256 - * characters. + * GTLRDiscoveryEngine_GoogleApiHttpBody_Extensions_Item + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *tableId; - +@interface GTLRDiscoveryEngine_GoogleApiHttpBody_Extensions_Item : GTLRObject @end /** - * Access Control Configuration. + * A specific metric, identified by specifying values for all of the labels of + * a `MetricDescriptor`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAclConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiMetric : GTLRObject -/** Identity provider config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig *idpConfig; +/** + * The set of label values that uniquely identify this metric. All labels + * listed in the `MetricDescriptor` must be assigned values. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMetric_Labels *labels; /** - * Immutable. The full resource name of the acl configuration. Format: - * `projects/{project}/locations/{location}/aclConfig`. This field must be a - * UTF-8 encoded string with a length limit of 1024 characters. + * An existing metric type, see google.api.MetricDescriptor. For example, + * `custom.googleapis.com/invoice/paid/amount`. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, copy, nullable) NSString *type; @end /** - * Informations to support actions on the connector. + * The set of label values that uniquely identify this metric. All labels + * listed in the `MetricDescriptor` must be assigned values. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiMetric_Labels : GTLRObject +@end + /** - * Required. Params needed to support actions in the format of (Key, Value) - * pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, - * `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: - * `client_id` * Value: type STRING. The client ID for the service provider to - * identify your application. * Key: `client_secret` * Value:type STRING. The - * client secret generated by the application's authorization server. + * An object representing a resource that can be used for monitoring, logging, + * billing, or other purposes. Examples include virtual machine instances, + * databases, and storage devices such as disks. The `type` field identifies a + * MonitoredResourceDescriptor object that describes the resource's schema. + * Information in the `labels` field identifies the actual resource and its + * attributes according to the schema. For example, a particular Compute Engine + * VM instance could be represented by the following object, because the + * MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, + * `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { + * "project_id": "my-project", "instance_id": "12345678901234", "zone": + * "us-central1-a" }} */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig_ActionParams *actionParams; +@interface GTLRDiscoveryEngine_GoogleApiMonitoredResource : GTLRObject /** - * Output only. The connector contains the necessary parameters and is - * configured to support actions. - * - * Uses NSNumber of boolValue. + * Required. Values for all of the labels listed in the associated monitored + * resource descriptor. For example, Compute Engine VM instances use the labels + * `"project_id"`, `"instance_id"`, and `"zone"`. */ -@property(nonatomic, strong, nullable) NSNumber *isActionConfigured; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMonitoredResource_Labels *labels; /** - * Optional. The Service Directory resource name (projects/ * /locations/ * - * /namespaces/ * /services/ *) representing a VPC network endpoint used to - * connect to the data source's `instance_uri`, defined in - * DataConnector.params. Required when VPC Service Controls are enabled. + * Required. The monitored resource type. This field must match the `type` + * field of a MonitoredResourceDescriptor object. For example, the type of a + * Compute Engine VM instance is `gce_instance`. Some descriptors include the + * service name in the type; for example, the type of a Datastream stream is + * `datastream.googleapis.com/Stream`. */ -@property(nonatomic, copy, nullable) NSString *serviceName; +@property(nonatomic, copy, nullable) NSString *type; + +@end + /** - * Optional. Whether to use static secrets for the connector. If true, the - * secrets provided in the action_params will be ignored. + * Required. Values for all of the labels listed in the associated monitored + * resource descriptor. For example, Compute Engine VM instances use the labels + * `"project_id"`, `"instance_id"`, and `"zone"`. * - * Uses NSNumber of boolValue. + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *useStaticSecrets; +@interface GTLRDiscoveryEngine_GoogleApiMonitoredResource_Labels : GTLRObject +@end + + +/** + * Auxiliary metadata for a MonitoredResource object. MonitoredResource objects + * contain the minimum set of information to uniquely identify a monitored + * resource instance. There is some other useful auxiliary metadata. Monitoring + * and Logging use an ingestion pipeline to extract metadata for cloud + * resources of all types, and store the metadata in this message. + */ +@interface GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata : GTLRObject + +/** + * Output only. Values for predefined system metadata labels. System labels are + * a kind of metadata extracted by Google, including "machine_image", "vpc", + * "subnet_id", "security_group", "name", etc. System label values can be only + * strings, Boolean values, or a list of strings. For example: { "name": + * "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": + * false } + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_SystemLabels *systemLabels; + +/** Output only. A map of user-defined metadata labels. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_UserLabels *userLabels; @end /** - * Required. Params needed to support actions in the format of (Key, Value) - * pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, - * `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: - * `client_id` * Value: type STRING. The client ID for the service provider to - * identify your application. * Key: `client_secret` * Value:type STRING. The - * client secret generated by the application's authorization server. + * Output only. Values for predefined system metadata labels. System labels are + * a kind of metadata extracted by Google, including "machine_image", "vpc", + * "subnet_id", "security_group", "name", etc. System label values can be only + * strings, Boolean values, or a list of strings. For example: { "name": + * "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": + * false } * * @note This class is documented as having more properties of any valid JSON * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to * get the list of properties and then fetch them; or @c * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig_ActionParams : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_SystemLabels : GTLRObject @end /** - * Configuration data for advance site search. + * Output only. A map of user-defined metadata labels. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleApiMonitoredResourceMetadata_UserLabels : GTLRObject +@end + /** - * If set true, automatic refresh is disabled for the DataStore. - * - * Uses NSNumber of boolValue. + * The error payload that is populated on LRO sync APIs, including the + * following: * + * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` + * * + * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun` */ -@property(nonatomic, strong, nullable) NSNumber *disableAutomaticRefresh; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext : GTLRObject /** - * If set true, initial indexing is disabled for the DataStore. - * - * Uses NSNumber of boolValue. + * The full resource name of the Connector Run. Format: `projects/ * + * /locations/ * /collections/ * /dataConnector/connectorRuns/ *`. The + * `connector_run_id` is system-generated. */ -@property(nonatomic, strong, nullable) NSNumber *disableInitialIndex; - -@end - +@property(nonatomic, copy, nullable) NSString *connectorRun; /** - * The connector level alert config. + * The full resource name of the DataConnector. Format: `projects/ * + * /locations/ * /collections/ * /dataConnector`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *dataConnector; -/** Optional. The enrollment states of each alert. */ -@property(nonatomic, strong, nullable) NSArray *alertEnrollments; +/** The time when the connector run ended. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; -/** Immutable. The fully qualified resource name of the AlertPolicy. */ -@property(nonatomic, copy, nullable) NSString *alertPolicyName; +/** The entity to sync for the connector run. */ +@property(nonatomic, copy, nullable) NSString *entity; -@end +/** The operation resource name of the LRO to sync the connector. */ +@property(nonatomic, copy, nullable) NSString *operation; +/** The time when the connector run started. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; /** - * The alert enrollment status. + * The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment : GTLRObject +@property(nonatomic, copy, nullable) NSString *syncType; + +@end -/** Immutable. The id of an alert. */ -@property(nonatomic, copy, nullable) NSString *alertId; /** - * Required. The enrollment status of a customer. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_Declined - * Customer declined this policy. (Value: "DECLINED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_Enrolled - * Customer is enrolled in this policy. (Value: "ENROLLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified - * Default value. Used for customers who have not responded to the alert - * policy. (Value: "ENROLL_STATES_UNSPECIFIED") + * A description of the context in which an error occurred. */ -@property(nonatomic, copy, nullable) NSString *enrollState; - -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorContext : GTLRObject +/** The HTTP request which was processed when the error was triggered. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingHttpRequestContext *httpRequest; /** - * Defines an answer. + * The location in the source code where the decision was made to report the + * error, usually the place where it was logged. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingSourceLocation *reportLocation; + +@end + /** - * Additional answer-skipped reasons. This provides the reason for ignored - * cases. If nothing is skipped, this field is not set. + * An error log which is reported to the Error Reporting system. */ -@property(nonatomic, strong, nullable) NSArray *answerSkippedReasons; - -/** The textual answer. */ -@property(nonatomic, copy, nullable) NSString *answerText; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog : GTLRObject -/** List of blob attachments in the answer. */ -@property(nonatomic, strong, nullable) NSArray *blobAttachments; +/** The error payload that is populated on LRO connector sync APIs. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext *connectorRunPayload; -/** Citations. */ -@property(nonatomic, strong, nullable) NSArray *citations; +/** A description of the context in which the error occurred. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorContext *context; -/** Output only. Answer completed timestamp. */ -@property(nonatomic, strong, nullable) GTLRDateTime *completeTime; +/** The error payload that is populated on LRO import APIs. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingImportErrorContext *importPayload; -/** Output only. Answer creation timestamp. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** A message describing the error. */ +@property(nonatomic, copy, nullable) NSString *message; /** - * A score in the range of [0, 1] describing how grounded the answer is by the - * reference chunks. - * - * Uses NSNumber of doubleValue. + * The API request payload, represented as a protocol buffer. Most API request + * types are supported—for example: * + * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` + * * + * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` */ -@property(nonatomic, strong, nullable) NSNumber *groundingScore; - -/** Optional. Grounding supports. */ -@property(nonatomic, strong, nullable) NSArray *groundingSupports; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_RequestPayload *requestPayload; /** - * Immutable. Fully qualified name - * `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/ - * * /answers/ *` + * The API response payload, represented as a protocol buffer. This is used to + * log some "soft errors", where the response is valid but we consider there + * are some quality issues like unjoined events. The following API responses + * are supported, and no PII is included: * + * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * + * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * + * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_ResponsePayload *responsePayload; -/** Query understanding information. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo *queryUnderstandingInfo; +/** The service context in which this error has occurred. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingServiceContext *serviceContext; -/** References. */ -@property(nonatomic, strong, nullable) NSArray *references; +/** The RPC status associated with the error log. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *status; -/** Suggested related questions. */ -@property(nonatomic, strong, nullable) NSArray *relatedQuestions; +@end -/** Optional. Safety ratings. */ -@property(nonatomic, strong, nullable) NSArray *safetyRatings; /** - * The state of the answer generation. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_Failed - * Answer generation currently failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_InProgress - * Answer generation is currently in progress. (Value: "IN_PROGRESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_StateUnspecified - * Unknown. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_Streaming - * Answer generation is currently in progress. (Value: "STREAMING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_Succeeded - * Answer generation has succeeded. (Value: "SUCCEEDED") + * The API request payload, represented as a protocol buffer. Most API request + * types are supported—for example: * + * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` + * * + * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest` + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *state; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_RequestPayload : GTLRObject +@end -/** Answer generation steps. */ -@property(nonatomic, strong, nullable) NSArray *steps; +/** + * The API response payload, represented as a protocol buffer. This is used to + * log some "soft errors", where the response is valid but we consider there + * are some quality issues like unjoined events. The following API responses + * are supported, and no PII is included: * + * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * + * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * + * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent` + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingErrorLog_ResponsePayload : GTLRObject @end /** - * Stores binarydata attached to text answer, e.g. image, video, audio, etc. + * HTTP request data that is related to a reported error. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingHttpRequestContext : GTLRObject /** - * Output only. The attribution type of the blob. + * The HTTP response status code for the request. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment_AttributionType_AttributionTypeUnspecified - * Unspecified attribution type. (Value: "ATTRIBUTION_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment_AttributionType_Corpus - * The attachment data is from the corpus. (Value: "CORPUS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment_AttributionType_Generated - * The attachment data is generated by the model through code generation. - * (Value: "GENERATED") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *attributionType; - -/** Output only. The mime type and data of the blob. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob *data; +@property(nonatomic, strong, nullable) NSNumber *responseStatusCode; @end /** - * The media type and data of the blob. + * The error payload that is populated on LRO import APIs, including the + * following: * + * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * + * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingImportErrorContext : GTLRObject + +/** The detailed content which caused the error on importing a document. */ +@property(nonatomic, copy, nullable) NSString *document; /** - * Output only. Raw bytes. - * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Google Cloud Storage file path of the import source. Can be set for batch + * operation error. */ -@property(nonatomic, copy, nullable) NSString *data; +@property(nonatomic, copy, nullable) NSString *gcsPath; /** - * Output only. The media type (MIME type) of the generated or retrieved data. + * Line number of the content in file. Should be empty for permission or batch + * operation error. */ -@property(nonatomic, copy, nullable) NSString *mimeType; +@property(nonatomic, copy, nullable) NSString *lineNumber; + +/** The operation resource name of the LRO. */ +@property(nonatomic, copy, nullable) NSString *operation; + +/** The detailed content which caused the error on importing a user event. */ +@property(nonatomic, copy, nullable) NSString *userEvent; @end /** - * Citation info for a segment. + * Describes a running service that sends errors. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerCitation : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingServiceContext : GTLRObject /** - * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). - * If there are multi-byte characters,such as non-ASCII characters, the index - * measurement is longer than the string length. - * - * Uses NSNumber of longLongValue. + * An identifier of the service—for example, `discoveryengine.googleapis.com`. */ -@property(nonatomic, strong, nullable) NSNumber *endIndex; +@property(nonatomic, copy, nullable) NSString *service; + +@end -/** Citation sources for the attributed segment. */ -@property(nonatomic, strong, nullable) NSArray *sources; /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). - * If there are multi-byte characters,such as non-ASCII characters, the index - * measurement is longer than the string length. - * - * Uses NSNumber of longLongValue. + * Indicates a location in the source code of the service for which errors are + * reported. */ -@property(nonatomic, strong, nullable) NSNumber *startIndex; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineLoggingSourceLocation : GTLRObject + +/** + * Human-readable name of a function or method—for example, + * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. + */ +@property(nonatomic, copy, nullable) NSString *functionName; @end /** - * Citation source. + * Access Control Configuration. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerCitationSource : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AclConfig : GTLRObject -/** ID of the citation source. */ -@property(nonatomic, copy, nullable) NSString *referenceId; +/** Identity provider config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdpConfig *idpConfig; + +/** + * Immutable. The full resource name of the acl configuration. Format: + * `projects/{project}/locations/{location}/aclConfig`. This field must be a + * UTF-8 encoded string with a length limit of 1024 characters. + */ +@property(nonatomic, copy, nullable) NSString *name; @end /** - * Grounding support for a claim in `answer_text`. + * Informations to support actions on the connector. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig : GTLRObject -/** - * Required. End of the claim, exclusive. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *endIndex; +/** Optional. Action parameters in structured json format. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig_ActionParams *actionParams; /** - * Indicates that this claim required grounding check. When the system decided - * this claim didn't require attribution/grounding check, this field is set to - * false. In that case, no grounding check was done for the claim and therefore - * `grounding_score`, `sources` is not returned. + * Output only. The connector contains the necessary parameters and is + * configured to support actions. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *groundingCheckRequired; +@property(nonatomic, strong, nullable) NSNumber *isActionConfigured; + +/** Optional. Action parameters in json string format. */ +@property(nonatomic, copy, nullable) NSString *jsonActionParams; /** - * A score in the range of [0, 1] describing how grounded is a specific claim - * by the references. Higher value means that the claim is better supported by - * the reference chunks. - * - * Uses NSNumber of doubleValue. + * Optional. The Service Directory resource name (projects/ * /locations/ * + * /namespaces/ * /services/ *) representing a VPC network endpoint used to + * connect to the data source's `instance_uri`, defined in + * DataConnector.params. Required when VPC Service Controls are enabled. */ -@property(nonatomic, strong, nullable) NSNumber *groundingScore; - -/** Optional. Citation sources for the claim. */ -@property(nonatomic, strong, nullable) NSArray *sources; +@property(nonatomic, copy, nullable) NSString *serviceName; /** - * Required. Index indicates the start of the claim, measured in bytes (UTF-8 - * unicode). + * Optional. Whether to use static secrets for the connector. If true, the + * secrets provided in the action_params will be ignored. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *startIndex; +@property(nonatomic, strong, nullable) NSNumber *useStaticSecrets; @end /** - * Query understanding information. + * Optional. Action parameters in structured json format. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo : GTLRObject - -/** Query classification information. */ -@property(nonatomic, strong, nullable) NSArray *queryClassificationInfo; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig_ActionParams : GTLRObject @end /** - * Query classification information. + * Request message for CompletionService.AdvancedCompleteQuery method. . */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest : GTLRObject + +/** Optional. Specification to boost suggestions matching the condition. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec *boostSpec; + +/** Optional. Experiment ids for this request. */ +@property(nonatomic, strong, nullable) NSArray *experimentIds; /** - * Classification output. + * Indicates if tail suggestions should be returned if there are no suggestions + * that match the full query. Even if set to true, if there are suggestions + * that match the full query, those are returned and no tail suggestions are + * returned. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *positive; +@property(nonatomic, strong, nullable) NSNumber *includeTailSuggestions; /** - * Query classification type. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_AdversarialQuery - * Adversarial query classification type. (Value: "ADVERSARIAL_QUERY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_JailBreakingQuery - * Jail-breaking query classification type. (Value: - * "JAIL_BREAKING_QUERY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_NonAnswerSeekingQuery - * Non-answer-seeking query classification type, for chit chat. (Value: - * "NON_ANSWER_SEEKING_QUERY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_NonAnswerSeekingQueryV2 - * Non-answer-seeking query classification type, for no clear intent. - * (Value: "NON_ANSWER_SEEKING_QUERY_V2") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_TypeUnspecified - * Unspecified query classification type. (Value: "TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_UserDefinedClassificationQuery - * User defined query classification type. (Value: - * "USER_DEFINED_CLASSIFICATION_QUERY") + * Required. The typeahead input used to fetch suggestions. Maximum length is + * 128 characters. The query can not be empty for most of the suggestion types. + * If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is + * when the suggestion_types contains only the type `RECENT_SEARCH`, the query + * can be an empty string. The is called "zero prefix" feature, which returns + * user's recently searched queries given the empty query. */ -@property(nonatomic, copy, nullable) NSString *type; - -@end +@property(nonatomic, copy, nullable) NSString *query; +/** + * Specifies the autocomplete query model, which only applies to the QUERY + * SuggestionType. This overrides any model specified in the Configuration > + * Autocomplete section of the Cloud console. Currently supported values: * + * `document` - Using suggestions generated from user-imported documents. * + * `search-history` - Using suggestions generated from the past history of + * SearchService.Search API calls. Do not use it when there is no traffic for + * Search API. * `user-event` - Using suggestions generated from user-imported + * search events. * `document-completable` - Using suggestions taken directly + * from user-imported document fields marked as completable. Default values: * + * `document` is the default model for regular dataStores. * `search-history` + * is the default model for site search dataStores. + */ +@property(nonatomic, copy, nullable) NSString *queryModel; /** - * Reference. + * Optional. Suggestion types to return. If empty or unspecified, query + * suggestions are returned. Only one suggestion type is supported at the + * moment. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReference : GTLRObject +@property(nonatomic, strong, nullable) NSArray *suggestionTypes; -/** Chunk information. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo *chunkInfo; +/** Optional. Specification of each suggestion type. */ +@property(nonatomic, strong, nullable) NSArray *suggestionTypeSpecs; -/** Structured document information. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo *structuredDocumentInfo; +/** + * Optional. Information about the end user. This should be the same identifier + * information as UserEvent.user_info and SearchRequest.user_info. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1UserInfo *userInfo; -/** Unstructured document information. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo *unstructuredDocumentInfo; +/** + * A unique identifier for tracking visitors. For example, this could be + * implemented with an HTTP cookie, which should be able to uniquely identify a + * visitor on a single device. This unique identifier should not change if the + * visitor logs in or out of the website. This field should NOT have a fixed + * value such as `unknown_visitor`. This should be the same identifier as + * UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be + * a UTF-8 encoded string with a length limit of 128 + */ +@property(nonatomic, copy, nullable) NSString *userPseudoId; @end /** - * Chunk information. + * Specification to boost suggestions based on the condtion of the suggestion. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec : GTLRObject /** - * Output only. Stores indexes of blobattachments linked to this chunk. - * - * Uses NSNumber of longLongValue. + * Condition boost specifications. If a suggestion matches multiple conditions + * in the specifications, boost values from these specifications are all + * applied and combined in a non-linear way. Maximum number of specifications + * is 20. Note: Currently only support language condition boost. */ -@property(nonatomic, strong, nullable) NSArray *blobAttachmentIndexes; +@property(nonatomic, strong, nullable) NSArray *conditionBoostSpecs; -/** Chunk resource name. */ -@property(nonatomic, copy, nullable) NSString *chunk; +@end -/** Chunk textual content. */ -@property(nonatomic, copy, nullable) NSString *content; -/** Document metadata. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata *documentMetadata; +/** + * Boost applies to suggestions which match a condition. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec : GTLRObject /** - * The relevance of the chunk for a given query. Values range from 0.0 - * (completely irrelevant) to 1.0 (completely relevant). This value is for - * informational purpose only. It may change for the same query and chunk at - * any time due to a model retraining or change in implementation. + * Strength of the boost, which should be in [-1, 1]. Negative boost means + * demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big + * promotion. However, it does not necessarily mean that the top result will be + * a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. + * However, other suggestions that are relevant might still be shown. Setting + * to 0.0 means no boost applied. The boosting condition is ignored. * * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *relevanceScore; - -@end - +@property(nonatomic, strong, nullable) NSNumber *boost; /** - * Document metadata. + * An expression which specifies a boost condition. The syntax is the same as + * [filter expression + * syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). + * Currently, the only supported condition is a list of BCP-47 lang codes. + * Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: + * ANY("en", "fr"))` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *condition; -/** Document resource name. */ -@property(nonatomic, copy, nullable) NSString *document; +@end -/** Page identifier. */ -@property(nonatomic, copy, nullable) NSString *pageIdentifier; /** - * The structured JSON metadata for the document. It is populated from the - * struct data from the Chunk in search result. + * Specification of each suggestion type. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata_StructData *structData; - -/** Title. */ -@property(nonatomic, copy, nullable) NSString *title; - -/** URI for the document. */ -@property(nonatomic, copy, nullable) NSString *uri; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec : GTLRObject /** - * The structured JSON metadata for the document. It is populated from the - * struct data from the Chunk in search result. + * Optional. Maximum number of suggestions to return for each suggestion type. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata_StructData : GTLRObject -@end - +@property(nonatomic, strong, nullable) NSNumber *maxSuggestions; /** - * Structured search information. + * Optional. Suggestion type. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_Content + * Returns content suggestions. (Value: "CONTENT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_GoogleWorkspace + * Returns Google Workspace suggestions. (Value: "GOOGLE_WORKSPACE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_People + * Returns people suggestions. (Value: "PEOPLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_Query + * Returns query suggestions. (Value: "QUERY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_RecentSearch + * Returns recent search suggestions. (Value: "RECENT_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec_SuggestionType_SuggestionTypeUnspecified + * Default value. (Value: "SUGGESTION_TYPE_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo : GTLRObject - -/** Document resource name. */ -@property(nonatomic, copy, nullable) NSString *document; - -/** Structured search data. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo_StructData *structData; - -/** Output only. The title of the document. */ -@property(nonatomic, copy, nullable) NSString *title; - -/** Output only. The URI of the document. */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, copy, nullable) NSString *suggestionType; @end /** - * Structured search data. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Response message for CompletionService.AdvancedCompleteQuery method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo_StructData : GTLRObject -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse : GTLRObject /** - * Unstructured document information. + * Results of the matched content suggestions. The result list is ordered and + * the first result is the top suggestion. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo : GTLRObject - -/** List of cited chunk contents derived from document content. */ -@property(nonatomic, strong, nullable) NSArray *chunkContents; - -/** Document resource name. */ -@property(nonatomic, copy, nullable) NSString *document; +@property(nonatomic, strong, nullable) NSArray *contentSuggestions; /** - * The structured JSON metadata for the document. It is populated from the - * struct data from the Chunk in search result. + * Results of the matched people suggestions. The result list is ordered and + * the first result is the top suggestion. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo_StructData *structData; - -/** Title. */ -@property(nonatomic, copy, nullable) NSString *title; - -/** URI for the document. */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, strong, nullable) NSArray *peopleSuggestions; -@end +/** + * Results of the matched query suggestions. The result list is ordered and the + * first result is a top suggestion. + */ +@property(nonatomic, strong, nullable) NSArray *querySuggestions; +/** + * Results of the matched "recent search" suggestions. The result list is + * ordered and the first result is the top suggestion. + */ +@property(nonatomic, strong, nullable) NSArray *recentSearchSuggestions; /** - * The structured JSON metadata for the document. It is populated from the - * struct data from the Chunk in search result. + * True if the returned suggestions are all tail suggestions. For tail matching + * to be triggered, include_tail_suggestions in the request must be true and + * there must be no suggestions that match the full query. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo_StructData : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *tailMatchTriggered; + @end /** - * Chunk content. + * Suggestions as content. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion : GTLRObject /** - * Output only. Stores indexes of blobattachments linked to this chunk. + * The type of the content suggestion. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion_ContentType_ContentTypeUnspecified + * Default value. (Value: "CONTENT_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion_ContentType_GoogleWorkspace + * The suggestion is from a Google Workspace source. (Value: + * "GOOGLE_WORKSPACE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion_ContentType_ThirdParty + * The suggestion is from a third party source. (Value: "THIRD_PARTY") */ -@property(nonatomic, strong, nullable) NSArray *blobAttachmentIndexes; +@property(nonatomic, copy, nullable) NSString *contentType; -/** Chunk textual content. */ -@property(nonatomic, copy, nullable) NSString *content; +/** The name of the dataStore that this suggestion belongs to. */ +@property(nonatomic, copy, nullable) NSString *dataStore; -/** Page identifier. */ -@property(nonatomic, copy, nullable) NSString *pageIdentifier; +/** The destination uri of the content suggestion. */ +@property(nonatomic, copy, nullable) NSString *destinationUri; /** - * The relevance of the chunk for a given query. Values range from 0.0 - * (completely irrelevant) to 1.0 (completely relevant). This value is for - * informational purpose only. It may change for the same query and chunk at - * any time due to a model retraining or change in implementation. + * The document data snippet in the suggestion. Only a subset of fields will be + * populated. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document *document; + +/** The icon uri of the content suggestion. */ +@property(nonatomic, copy, nullable) NSString *iconUri; + +/** + * The score of each suggestion. The score is in the range of [0, 1]. * - * Uses NSNumber of floatValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *relevanceScore; +@property(nonatomic, strong, nullable) NSNumber *score; + +/** The suggestion for the query. */ +@property(nonatomic, copy, nullable) NSString *suggestion; @end /** - * Step information. + * Suggestions as people. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion : GTLRObject -/** Actions. */ -@property(nonatomic, strong, nullable) NSArray *actions; +/** The name of the dataStore that this suggestion belongs to. */ +@property(nonatomic, copy, nullable) NSString *dataStore; + +/** The destination uri of the person suggestion. */ +@property(nonatomic, copy, nullable) NSString *destinationUri; + +/** The photo uri of the person suggestion. */ +@property(nonatomic, copy, nullable) NSString *displayPhotoUri; /** - * The description of the step. - * - * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + * The document data snippet in the suggestion. Only a subset of fields is + * populated. */ -@property(nonatomic, copy, nullable) NSString *descriptionProperty; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Document *document; /** - * The state of the step. + * The type of the person. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_Failed - * Step currently failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_InProgress - * Step is currently in progress. (Value: "IN_PROGRESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_StateUnspecified - * Unknown. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_Succeeded - * Step has succeeded. (Value: "SUCCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_CloudIdentity + * The suggestion is from a GOOGLE_IDENTITY source. (Value: + * "CLOUD_IDENTITY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_PersonTypeUnspecified + * Default value. (Value: "PERSON_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion_PersonType_ThirdPartyIdentity + * The suggestion is from a THIRD_PARTY_IDENTITY source. (Value: + * "THIRD_PARTY_IDENTITY") */ -@property(nonatomic, copy, nullable) NSString *state; - -/** The thought of the step. */ -@property(nonatomic, copy, nullable) NSString *thought; - -@end - +@property(nonatomic, copy, nullable) NSString *personType; /** - * Action. + * The score of each suggestion. The score is in the range of [0, 1]. + * + * Uses NSNumber of doubleValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepAction : GTLRObject - -/** Observation. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation *observation; +@property(nonatomic, strong, nullable) NSNumber *score; -/** Search action. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction *searchAction; +/** The suggestion for the query. */ +@property(nonatomic, copy, nullable) NSString *suggestion; @end /** - * Observation. + * Suggestions as search queries. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion : GTLRObject /** - * Search results observed by the search action, it can be snippets info or - * chunk info, depending on the citation type set by the user. + * The unique document field paths that serve as the source of this suggestion + * if it was generated from completable fields. This field is only populated + * for the document-completable model. */ -@property(nonatomic, strong, nullable) NSArray *searchResults; - -@end +@property(nonatomic, strong, nullable) NSArray *completableFieldPaths; +/** The name of the dataStore that this suggestion belongs to. */ +@property(nonatomic, strong, nullable) NSArray *dataStore; /** - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult + * The score of each suggestion. The score is in the range of [0, 1]. + * + * Uses NSNumber of doubleValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *score; -/** - * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate - * chunk info. - */ -@property(nonatomic, strong, nullable) NSArray *chunkInfo; +/** The suggestion for the query. */ +@property(nonatomic, copy, nullable) NSString *suggestion; + +@end -/** Document resource name. */ -@property(nonatomic, copy, nullable) NSString *document; /** - * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level - * snippets. + * Suggestions from recent search history. */ -@property(nonatomic, strong, nullable) NSArray *snippetInfo; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion : GTLRObject + +/** The time when this recent rearch happened. */ +@property(nonatomic, strong, nullable) GTLRDateTime *recentSearchTime; /** - * Data representation. The structured JSON data for the document. It's - * populated from the struct data from the Document, or the Chunk in search - * result. + * The score of each suggestion. The score is in the range of [0, 1]. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult_StructData *structData; - -/** Title. */ -@property(nonatomic, copy, nullable) NSString *title; +@property(nonatomic, strong, nullable) NSNumber *score; -/** URI for the document. */ -@property(nonatomic, copy, nullable) NSString *uri; +/** The suggestion for the query. */ +@property(nonatomic, copy, nullable) NSString *suggestion; @end /** - * Data representation. The structured JSON data for the document. It's - * populated from the struct data from the Document, or the Chunk in search - * result. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Configuration data for advance site search. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult_StructData : GTLRObject -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig : GTLRObject /** - * Chunk information. + * If set true, automatic refresh is disabled for the DataStore. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo : GTLRObject - -/** Chunk resource name. */ -@property(nonatomic, copy, nullable) NSString *chunk; - -/** Chunk textual content. */ -@property(nonatomic, copy, nullable) NSString *content; +@property(nonatomic, strong, nullable) NSNumber *disableAutomaticRefresh; /** - * The relevance of the chunk for a given query. Values range from 0.0 - * (completely irrelevant) to 1.0 (completely relevant). This value is for - * informational purpose only. It may change for the same query and chunk at - * any time due to a model retraining or change in implementation. + * If set true, initial indexing is disabled for the DataStore. * - * Uses NSNumber of floatValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *relevanceScore; +@property(nonatomic, strong, nullable) NSNumber *disableInitialIndex; @end /** - * Snippet information. + * The connector level alert config. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfig : GTLRObject -/** Snippet content. */ -@property(nonatomic, copy, nullable) NSString *snippet; +/** Optional. The enrollment states of each alert. */ +@property(nonatomic, strong, nullable) NSArray *alertEnrollments; -/** Status of the snippet defined by the search team. */ -@property(nonatomic, copy, nullable) NSString *snippetStatus; +/** Immutable. The fully qualified resource name of the AlertPolicy. */ +@property(nonatomic, copy, nullable) NSString *alertPolicyName; @end /** - * Search action. + * The alert enrollment status. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction : GTLRObject - -/** The query to search. */ -@property(nonatomic, copy, nullable) NSString *query; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment : GTLRObject -/** - * The configuration for the BAP connector. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig : GTLRObject +/** Immutable. The id of an alert. */ +@property(nonatomic, copy, nullable) NSString *alertId; /** - * Required. The supported connector modes for the associated BAP connection. + * Required. The enrollment status of a customer. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_Declined + * Customer declined this policy. (Value: "DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_Enrolled + * Customer is enrolled in this policy. (Value: "ENROLLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified + * Default value. Used for customers who have not responded to the alert + * policy. (Value: "ENROLL_STATES_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSArray *supportedConnectorModes; +@property(nonatomic, copy, nullable) NSString *enrollState; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.BatchCreateTargetSites operation. This will be - * returned by the google.longrunning.Operation.metadata field. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The resource level alert config. Used in: * UserLicense * EngineUserData The + * AlertPolicyConfig in data connector is of same usage. No easy way to + * migrate. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig : GTLRObject -@end +/** Optional. The enrollment state of each alert. */ +@property(nonatomic, strong, nullable) NSArray *alertEnrollments; +/** Immutable. The fully qualified resource name of the AlertPolicy. */ +@property(nonatomic, copy, nullable) NSString *alertPolicy; -/** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse : GTLRObject +/** Optional. The contact details for each alert policy. */ +@property(nonatomic, strong, nullable) NSArray *contactDetails; -/** TargetSites created. */ -@property(nonatomic, strong, nullable) NSArray *targetSites; +/** Optional. The language code used for notifications */ +@property(nonatomic, copy, nullable) NSString *languageCode; @end /** - * Metadata related to the progress of the - * UserLicenseService.BatchUpdateUserLicenses operation. This will be returned - * by the google.longrunning.Operation.metadata field. + * The alert enrollment status. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment : GTLRObject -/** - * Count of user licenses that failed to be updated. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +/** Immutable. The id of an alert. */ +@property(nonatomic, copy, nullable) NSString *alertId; /** - * Count of user licenses successfully updated. + * Required. The enrollment status of a customer. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined + * Customer declined this policy. (Value: "DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled + * Customer is enrolled in this policy. (Value: "ENROLLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified + * Default value. Used for customers who have not responded to the alert + * policy. (Value: "ENROLL_STATE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, copy, nullable) NSString *enrollState; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Parameters used to instantiate a notification. Used for + * notifications that are triggered when registered. Not stored. * Gemini + * Business welcome emails. * Gemini Business user invitation emails. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_NotificationParams *notificationParams; @end /** - * Response message for UserLicenseService.BatchUpdateUserLicenses method. + * Optional. Parameters used to instantiate a notification. Used for + * notifications that are triggered when registered. Not stored. * Gemini + * Business welcome emails. * Gemini Business user invitation emails. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse : GTLRObject - -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; - -/** UserLicenses successfully updated. */ -@property(nonatomic, strong, nullable) NSArray *userLicenses; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfigAlertEnrollment_NotificationParams : GTLRObject @end /** - * Configurations used to enable CMEK data encryption with Cloud KMS keys. + * AlloyDB source import data from. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlloyDbSource : GTLRObject /** - * Output only. The default CmekConfig for the Customer. - * - * Uses NSNumber of boolValue. + * Required. The AlloyDB cluster to copy the data from with a length limit of + * 256 characters. */ -@property(nonatomic, strong, nullable) NSNumber *isDefault; +@property(nonatomic, copy, nullable) NSString *clusterId; /** - * Required. KMS key resource name which will be used to encrypt resources - * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + * Required. The AlloyDB database to copy the data from with a length limit of + * 256 characters. */ -@property(nonatomic, copy, nullable) NSString *kmsKey; +@property(nonatomic, copy, nullable) NSString *databaseId; /** - * Output only. KMS key version resource name which will be used to encrypt - * resources `/cryptoKeyVersions/{keyVersion}`. + * Intermediate Cloud Storage directory used for the import with a length limit + * of 2,000 characters. Can be specified if one wants to have the AlloyDB + * export to a specific Cloud Storage directory. Ensure that the AlloyDB + * service account has the necessary Cloud Storage Admin permissions to access + * the specified Cloud Storage directory. */ -@property(nonatomic, copy, nullable) NSString *kmsKeyVersion; +@property(nonatomic, copy, nullable) NSString *gcsStagingDir; /** - * Output only. The timestamp of the last key rotation. - * - * Uses NSNumber of longLongValue. + * Required. The AlloyDB location to copy the data from with a length limit of + * 256 characters. */ -@property(nonatomic, strong, nullable) NSNumber *lastRotationTimestampMicros; +@property(nonatomic, copy, nullable) NSString *locationId; /** - * Required. The name of the CmekConfig of the form - * `projects/{project}/locations/{location}/cmekConfig` or - * `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + * The project ID that contains the AlloyDB source. Has a length limit of 128 + * characters. If not specified, inherits the project ID from the parent + * request. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, copy, nullable) NSString *projectId; /** - * Output only. Whether the NotebookLM Corpus is ready to be used. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmNotEnabled - * The NotebookLM is not enabled. (Value: "NOTEBOOK_LM_NOT_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmNotReady - * The NotebookLM is not ready. (Value: "NOTEBOOK_LM_NOT_READY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmReady - * The NotebookLM is ready to be used. (Value: "NOTEBOOK_LM_READY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmStateUnspecified - * The NotebookLM state is unknown. (Value: - * "NOTEBOOK_LM_STATE_UNSPECIFIED") + * Required. The AlloyDB table to copy the data from with a length limit of 256 + * characters. */ -@property(nonatomic, copy, nullable) NSString *notebooklmState; +@property(nonatomic, copy, nullable) NSString *tableId; + +@end + /** - * Optional. Single-regional CMEKs that are required for some VAIS features. + * Access Control Configuration. */ -@property(nonatomic, strong, nullable) NSArray *singleRegionKeys; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAclConfig : GTLRObject + +/** Identity provider config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig *idpConfig; /** - * Output only. The states of the CmekConfig. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Active - * The CmekConfig can be used with DataStores. (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_ActiveRotating - * The KMS key version is being rotated. (Value: "ACTIVE_ROTATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Creating - * The CmekConfig is creating. (Value: "CREATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleted - * The KMS key is soft deleted. Some cleanup policy will eventually be - * applied. (Value: "DELETED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_DeleteFailed - * The CmekConfig deletion process failed. (Value: "DELETE_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleting - * The CmekConfig is deleting. (Value: "DELETING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_KeyIssue - * The CmekConfig is unavailable, most likely due to the KMS Key being - * revoked. (Value: "KEY_ISSUE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_StateUnspecified - * The CmekConfig state is unknown. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Unusable - * The CmekConfig is not usable, most likely due to some internal issue. - * (Value: "UNUSABLE") + * Immutable. The full resource name of the acl configuration. Format: + * `projects/{project}/locations/{location}/aclConfig`. This field must be a + * UTF-8 encoded string with a length limit of 1024 characters. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, copy, nullable) NSString *name; @end /** - * Collection is a container for configuring resources and access to a set of - * DataStores. + * Informations to support actions on the connector. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCollection : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig : GTLRObject -/** Output only. Timestamp the Collection was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. Action parameters in structured json format. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig_ActionParams *actionParams; /** - * Output only. The data connector, if present, manages the connection for data - * stores in the Collection. To set up the connector, use - * DataConnectorService.SetUpDataConnector method, which creates a new - * Collection while setting up the DataConnector singleton resource. Setting up - * connector on an existing Collection is not supported. This output only field - * contains a subset of the DataConnector fields, including `name`, - * `data_source`, `entities.entity_name` and `entities.data_store`. To get more - * details about a data connector, use the - * DataConnectorService.GetDataConnector method. + * Output only. The connector contains the necessary parameters and is + * configured to support actions. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector *dataConnector; +@property(nonatomic, strong, nullable) NSNumber *isActionConfigured; + +/** Optional. Action parameters in json string format. */ +@property(nonatomic, copy, nullable) NSString *jsonActionParams; /** - * Required. The Collection display name. This field must be a UTF-8 encoded - * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT - * error is returned. + * Optional. The Service Directory resource name (projects/ * /locations/ * + * /namespaces/ * /services/ *) representing a VPC network endpoint used to + * connect to the data source's `instance_uri`, defined in + * DataConnector.params. Required when VPC Service Controls are enabled. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@property(nonatomic, copy, nullable) NSString *serviceName; /** - * Immutable. The full resource name of the Collection. Format: - * `projects/{project}/locations/{location}/collections/{collection_id}`. This - * field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Optional. Whether to use static secrets for the connector. If true, the + * secrets provided in the action_params will be ignored. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSNumber *useStaticSecrets; @end /** - * Defines circumstances to be checked before allowing a behavior + * Optional. Action parameters in structured json format. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig_ActionParams : GTLRObject +@end + /** - * Range of time(s) specifying when condition is active. Maximum of 10 time - * ranges. + * Configuration data for advance site search. */ -@property(nonatomic, strong, nullable) NSArray *activeTimeRange; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig : GTLRObject /** - * Optional. Query regex to match the whole search query. Cannot be set when - * Condition.query_terms is set. Only supported for Basic Site Search promotion - * serving controls. + * If set true, automatic refresh is disabled for the DataStore. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *queryRegex; +@property(nonatomic, strong, nullable) NSNumber *disableAutomaticRefresh; /** - * Search only A list of terms to match the query on. Cannot be set when - * Condition.query_regex is set. Maximum of 10 query terms. + * If set true, initial indexing is disabled for the DataStore. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *queryTerms; +@property(nonatomic, strong, nullable) NSNumber *disableInitialIndex; @end /** - * Matcher for search request query + * The connector level alert config. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig : GTLRObject + +/** Optional. The enrollment states of each alert. */ +@property(nonatomic, strong, nullable) NSArray *alertEnrollments; + +/** Immutable. The fully qualified resource name of the AlertPolicy. */ +@property(nonatomic, copy, nullable) NSString *alertPolicyName; + +@end + /** - * Whether the search query needs to exactly match the query term. - * - * Uses NSNumber of boolValue. + * The alert enrollment status. */ -@property(nonatomic, strong, nullable) NSNumber *fullMatch; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment : GTLRObject + +/** Immutable. The id of an alert. */ +@property(nonatomic, copy, nullable) NSString *alertId; /** - * The specific query value to match against Must be lowercase, must be UTF-8. - * Can have at most 3 space separated terms if full_match is true. Cannot be an - * empty string. Maximum length of 5000 characters. + * Required. The enrollment status of a customer. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_Declined + * Customer declined this policy. (Value: "DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_Enrolled + * Customer is enrolled in this policy. (Value: "ENROLLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment_EnrollState_EnrollStatesUnspecified + * Default value. Used for customers who have not responded to the alert + * policy. (Value: "ENROLL_STATES_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *value; +@property(nonatomic, copy, nullable) NSString *enrollState; @end /** - * Used for time-dependent conditions. + * The resource level alert config. Used in: * UserLicense * EngineUserData The + * AlertPolicyConfig in data connector is of same usage. No easy way to + * migrate. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig : GTLRObject -/** End of time range. Range is inclusive. Must be in the future. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** Optional. The enrollment state of each alert. */ +@property(nonatomic, strong, nullable) NSArray *alertEnrollments; -/** Start of time range. Range is inclusive. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** Immutable. The fully qualified resource name of the AlertPolicy. */ +@property(nonatomic, copy, nullable) NSString *alertPolicy; + +/** Optional. The contact details for each alert policy. */ +@property(nonatomic, strong, nullable) NSArray *contactDetails; + +/** Optional. The language code used for notifications */ +@property(nonatomic, copy, nullable) NSString *languageCode; @end /** - * A data sync run of DataConnector. After DataConnector is successfully - * initialized, data syncs are scheduled at DataConnector.refresh_interval. A - * ConnectorRun represents a data sync either in the past or onging that the - * moment. // + * The alert enrollment status. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment : GTLRObject -/** Output only. The time when the connector run ended. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** Immutable. The id of an alert. */ +@property(nonatomic, copy, nullable) NSString *alertId; /** - * Output only. The details of the entities synced at the ConnectorRun. Each - * ConnectorRun consists of syncing one or more entities. + * Required. The enrollment status of a customer. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined + * Customer declined this policy. (Value: "DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled + * Customer is enrolled in this policy. (Value: "ENROLLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified + * Default value. Used for customers who have not responded to the alert + * policy. (Value: "ENROLL_STATE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSArray *entityRuns; +@property(nonatomic, copy, nullable) NSString *enrollState; /** - * Contains info about errors incurred during the sync. Only exist if running - * into an error state. Contains error code and error message. Use with the - * `state` field. + * Optional. Parameters used to instantiate a notification. Used for + * notifications that are triggered when registered. Not stored. * Gemini + * Business welcome emails. * Gemini Business user invitation emails. */ -@property(nonatomic, strong, nullable) NSArray *errors; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_NotificationParams *notificationParams; + +@end -/** Output only. The time when the connector run was most recently paused. */ -@property(nonatomic, strong, nullable) GTLRDateTime *latestPauseTime; /** - * Output only. The full resource name of the Connector Run. Format: `projects/ - * * /locations/ * /collections/ * /dataConnector/connectorRuns/ *`. The - * `connector_run_id` is system-generated. + * Optional. Parameters used to instantiate a notification. Used for + * notifications that are triggered when registered. Not stored. * Gemini + * Business welcome emails. * Gemini Business user invitation emails. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment_NotificationParams : GTLRObject +@end -/** Output only. The time when the connector run started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; /** - * Output only. The state of the sync run. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Cancelled - * Data sync was scheduled but has been cancelled. (Value: "CANCELLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Failed - * The data sync is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Overrun - * Data sync has been running longer than expected and is still running - * at the time the next run is supposed to start. (Value: "OVERRUN") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Pending - * Data sync is about to start. (Value: "PENDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Running - * The data sync is ongoing. (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Skipped - * An ongoing connector run has been running longer than expected, - * causing this run to be skipped. (Value: "SKIPPED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_StateUnspecified - * Default value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Succeeded - * The data sync is finished. (Value: "SUCCEEDED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Warning - * The data sync completed with non-fatal errors. (Value: "WARNING") + * Defines an answer. */ -@property(nonatomic, copy, nullable) NSString *state; - -/** Timestamp at which the connector run sync state was last updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *stateUpdateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer : GTLRObject /** - * Output only. The trigger for this ConnectorRun. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Initialization - * ConnectorRun auto triggered by connector initialization. (Value: - * "INITIALIZATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Manual - * ConnectorRun triggered by user manually. (Value: "MANUAL") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Resume - * ConnectorRun auto triggered by resuming connector. (Value: "RESUME") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Scheduler - * ConnectorRun triggered by scheduler if connector has PERIODIC sync - * mode. (Value: "SCHEDULER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_TriggerUnspecified - * Default value. (Value: "TRIGGER_UNSPECIFIED") + * Additional answer-skipped reasons. This provides the reason for ignored + * cases. If nothing is skipped, this field is not set. */ -@property(nonatomic, copy, nullable) NSString *trigger; +@property(nonatomic, strong, nullable) NSArray *answerSkippedReasons; -@end +/** The textual answer. */ +@property(nonatomic, copy, nullable) NSString *answerText; + +/** List of blob attachments in the answer. */ +@property(nonatomic, strong, nullable) NSArray *blobAttachments; + +/** Citations. */ +@property(nonatomic, strong, nullable) NSArray *citations; +/** Output only. Answer completed timestamp. */ +@property(nonatomic, strong, nullable) GTLRDateTime *completeTime; + +/** Output only. Answer creation timestamp. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Represents an entity that was synced in this ConnectorRun. + * A score in the range of [0, 1] describing how grounded the answer is by the + * reference chunks. + * + * Uses NSNumber of doubleValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *groundingScore; + +/** Optional. Grounding supports. */ +@property(nonatomic, strong, nullable) NSArray *groundingSupports; /** - * Optional. The number of documents deleted. - * - * Uses NSNumber of longLongValue. + * Immutable. Fully qualified name + * `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/ + * * /answers/ *` */ -@property(nonatomic, strong, nullable) NSNumber *deletedRecordCount; +@property(nonatomic, copy, nullable) NSString *name; + +/** Query understanding information. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo *queryUnderstandingInfo; + +/** References. */ +@property(nonatomic, strong, nullable) NSArray *references; + +/** Suggested related questions. */ +@property(nonatomic, strong, nullable) NSArray *relatedQuestions; + +/** Optional. Safety ratings. */ +@property(nonatomic, strong, nullable) NSArray *safetyRatings; /** - * The name of the source entity. + * The state of the answer generation. * - * Remapped to 'entityNameProperty' to avoid NSObject's 'entityName'. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_Failed + * Answer generation currently failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_InProgress + * Answer generation is currently in progress. (Value: "IN_PROGRESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_StateUnspecified + * Unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_Streaming + * Answer generation is currently in progress. (Value: "STREAMING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer_State_Succeeded + * Answer generation has succeeded. (Value: "SUCCEEDED") */ -@property(nonatomic, copy, nullable) NSString *entityNameProperty; +@property(nonatomic, copy, nullable) NSString *state; + +/** Answer generation steps. */ +@property(nonatomic, strong, nullable) NSArray *steps; + +@end + /** - * Optional. The total number of documents failed at sync at indexing stage. + * Stores binarydata attached to text answer, e.g. image, video, audio, etc. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment : GTLRObject + +/** + * Output only. The attribution type of the blob. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment_AttributionType_AttributionTypeUnspecified + * Unspecified attribution type. (Value: "ATTRIBUTION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment_AttributionType_Corpus + * The attachment data is from the corpus. (Value: "CORPUS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment_AttributionType_Generated + * The attachment data is generated by the model through code generation. + * (Value: "GENERATED") */ -@property(nonatomic, strong, nullable) NSNumber *errorRecordCount; +@property(nonatomic, copy, nullable) NSString *attributionType; + +/** Output only. The mime type and data of the blob. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob *data; + +@end + /** - * The errors from the entity's sync run. Only exist if running into an error - * state. Contains error code and error message. + * The media type and data of the blob. */ -@property(nonatomic, strong, nullable) NSArray *errors; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob : GTLRObject /** - * Optional. The number of documents extracted from connector source, ready to - * be ingested to VAIS. + * Output only. Raw bytes. * - * Uses NSNumber of longLongValue. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, strong, nullable) NSNumber *extractedRecordCount; +@property(nonatomic, copy, nullable) NSString *data; /** - * Optional. The number of documents indexed. - * - * Uses NSNumber of longLongValue. + * Output only. The media type (MIME type) of the generated or retrieved data. */ -@property(nonatomic, strong, nullable) NSNumber *indexedRecordCount; +@property(nonatomic, copy, nullable) NSString *mimeType; + +@end -/** Metadata to generate the progress bar. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress *progress; /** - * Optional. The number of documents scheduled to be crawled/extracted from - * connector source. This only applies to third party connectors. - * - * Uses NSNumber of longLongValue. + * Citation info for a segment. */ -@property(nonatomic, strong, nullable) NSNumber *scheduledRecordCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerCitation : GTLRObject /** - * Optional. The number of requests sent to 3p API. + * End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). + * If there are multi-byte characters,such as non-ASCII characters, the index + * measurement is longer than the string length. * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *sourceApiRequestCount; +@property(nonatomic, strong, nullable) NSNumber *endIndex; + +/** Citation sources for the attributed segment. */ +@property(nonatomic, strong, nullable) NSArray *sources; /** - * The state of the entity's sync run. + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * If there are multi-byte characters,such as non-ASCII characters, the index + * measurement is longer than the string length. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Cancelled - * Data sync was scheduled but has been cancelled. (Value: "CANCELLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Failed - * The data sync is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Overrun - * Data sync has been running longer than expected and is still running - * at the time the next run is supposed to start. (Value: "OVERRUN") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Pending - * Data sync is about to start. (Value: "PENDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Running - * The data sync is ongoing. (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Skipped - * An ongoing connector run has been running longer than expected, - * causing this run to be skipped. (Value: "SKIPPED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_StateUnspecified - * Default value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Succeeded - * The data sync is finished. (Value: "SUCCEEDED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Warning - * The data sync completed with non-fatal errors. (Value: "WARNING") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, strong, nullable) NSNumber *startIndex; -/** Timestamp at which the entity sync state was last updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *stateUpdateTime; +@end -/** - * The timestamp for either extracted_documents_count, indexed_documents_count - * and error_documents_count was last updated. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *statsUpdateTime; /** - * Sync type of this run. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_Full - * Sync triggers full sync of all documents. (Value: "FULL") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_Incremental - * Incremental sync of updated documents. (Value: "INCREMENTAL") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_Realtime - * Realtime sync. (Value: "REALTIME") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_ScalaSync - * Scala sync. (Value: "SCALA_SYNC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_SyncTypeUnspecified - * Sync type unspecified. (Value: "SYNC_TYPE_UNSPECIFIED") + * Citation source. */ -@property(nonatomic, copy, nullable) NSString *syncType; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerCitationSource : GTLRObject + +/** ID of the citation source. */ +@property(nonatomic, copy, nullable) NSString *referenceId; @end /** - * Represents the progress of a sync run. + * Grounding support for a claim in `answer_text`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport : GTLRObject /** - * The current progress. + * Required. End of the claim, exclusive. * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *currentCount; +@property(nonatomic, strong, nullable) NSNumber *endIndex; /** - * Derived. The percentile of the progress.current_count / total_count. The - * value is between [0, 1.0] inclusive. + * Indicates that this claim required grounding check. When the system decided + * this claim didn't require attribution/grounding check, this field is set to + * false. In that case, no grounding check was done for the claim and therefore + * `grounding_score`, `sources` is not returned. * - * Uses NSNumber of floatValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *percentile; +@property(nonatomic, strong, nullable) NSNumber *groundingCheckRequired; /** - * The total. + * A score in the range of [0, 1] describing how grounded is a specific claim + * by the references. Higher value means that the claim is better supported by + * the reference chunks. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *groundingScore; + +/** Optional. Citation sources for the claim. */ +@property(nonatomic, strong, nullable) NSArray *sources; + +/** + * Required. Index indicates the start of the claim, measured in bytes (UTF-8 + * unicode). * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@property(nonatomic, strong, nullable) NSNumber *startIndex; @end /** - * Defines a conditioned behavior to employ during serving. Must be attached to - * a ServingConfig to be considered at serving time. Permitted actions - * dependent on `SolutionType`. + * Query understanding information. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo : GTLRObject -/** - * Output only. List of all ServingConfig IDs this control is attached to. May - * take up to 10 minutes to update after changes. - */ -@property(nonatomic, strong, nullable) NSArray *associatedServingConfigIds; +/** Query classification information. */ +@property(nonatomic, strong, nullable) NSArray *queryClassificationInfo; -/** Defines a boost-type control */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction *boostAction; +@end -/** - * Determines when the associated action will trigger. Omit to always apply the - * action. Currently only a single condition may be specified. Otherwise an - * INVALID ARGUMENT error is thrown. - */ -@property(nonatomic, strong, nullable) NSArray *conditions; /** - * Required. Human readable name. The identifier used in UI views. Must be - * UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID - * ARGUMENT error is thrown. + * Query classification information. */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Defines a filter-type control Currently not supported by Recommendation */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlFilterAction *filterAction; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo : GTLRObject /** - * Immutable. Fully qualified name `projects/ * /locations/global/dataStore/ * - * /controls/ *` + * Classification output. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Promote certain links based on predefined trigger queries. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlPromoteAction *promoteAction; - -/** Defines a redirect-type control. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlRedirectAction *redirectAction; +@property(nonatomic, strong, nullable) NSNumber *positive; /** - * Required. Immutable. What solution the control belongs to. Must be - * compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is - * thrown. + * Query classification type. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeChat - * Used for use cases related to the Generative AI agent. (Value: - * "SOLUTION_TYPE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeGenerativeChat - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled - * with `SOLUTION_TYPE_CHAT` solution. (Value: - * "SOLUTION_TYPE_GENERATIVE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeRecommendation - * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeSearch - * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeUnspecified - * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_AdversarialQuery + * Adversarial query classification type. (Value: "ADVERSARIAL_QUERY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_JailBreakingQuery + * Jail-breaking query classification type. (Value: + * "JAIL_BREAKING_QUERY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_NonAnswerSeekingQuery + * Non-answer-seeking query classification type, for chit chat. (Value: + * "NON_ANSWER_SEEKING_QUERY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_NonAnswerSeekingQueryV2 + * Non-answer-seeking query classification type, for no clear intent. + * (Value: "NON_ANSWER_SEEKING_QUERY_V2") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_TypeUnspecified + * Unspecified query classification type. (Value: "TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo_Type_UserDefinedClassificationQuery + * User defined query classification type. (Value: + * "USER_DEFINED_CLASSIFICATION_QUERY") */ -@property(nonatomic, copy, nullable) NSString *solutionType; +@property(nonatomic, copy, nullable) NSString *type; + +@end -/** Treats a group of terms as synonyms of one another. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlSynonymsAction *synonymsAction; /** - * Specifies the use case for the control. Affects what condition fields can be - * set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case - * per control. Must be set when solution_type is - * SolutionType.SOLUTION_TYPE_SEARCH. + * Reference. */ -@property(nonatomic, strong, nullable) NSArray *useCases; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReference : GTLRObject + +/** Chunk information. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo *chunkInfo; + +/** Structured document information. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo *structuredDocumentInfo; + +/** Unstructured document information. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo *unstructuredDocumentInfo; @end /** - * Adjusts order of products in returned list. + * Chunk information. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo : GTLRObject /** - * Strength of the boost, which should be in [-1, 1]. Negative boost means - * demotion. Default is 0.0 (No-op). + * Output only. Stores indexes of blobattachments linked to this chunk. * - * Uses NSNumber of floatValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *boost GTLR_DEPRECATED; +@property(nonatomic, strong, nullable) NSArray *blobAttachmentIndexes; -/** - * Required. Specifies which data store's documents can be boosted by this - * control. Full data store name e.g. - * projects/123/locations/global/collections/default_collection/dataStores/default_data_store - */ -@property(nonatomic, copy, nullable) NSString *dataStore; +/** Chunk resource name. */ +@property(nonatomic, copy, nullable) NSString *chunk; -/** - * Required. Specifies which products to apply the boost to. If no filter is - * provided all products will be boosted (No-op). Syntax documentation: - * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 - * characters. Otherwise an INVALID ARGUMENT error is thrown. - */ -@property(nonatomic, copy, nullable) NSString *filter; +/** Chunk textual content. */ +@property(nonatomic, copy, nullable) NSString *content; + +/** Document metadata. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata *documentMetadata; /** - * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost - * means demotion. Default is 0.0 (No-op). + * The relevance of the chunk for a given query. Values range from 0.0 + * (completely irrelevant) to 1.0 (completely relevant). This value is for + * informational purpose only. It may change for the same query and chunk at + * any time due to a model retraining or change in implementation. * * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *fixedBoost; - -/** - * Optional. Complex specification for custom ranking based on customer defined - * attribute value. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec *interpolationBoostSpec; +@property(nonatomic, strong, nullable) NSNumber *relevanceScore; @end /** - * Specification for custom ranking based on customer specified attribute - * value. It provides more controls for customized ranking than the simple - * (condition, boost) combination above. + * Document metadata. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata : GTLRObject -/** - * Optional. The attribute type to be used to determine the boost amount. The - * attribute value can be derived from the field value of the specified - * field_name. In the case of numerical it is straightforward i.e. - * attribute_value = numerical_field_value. In the case of freshness however, - * attribute_value = (time.now() - datetime_field_value). - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_AttributeType_AttributeTypeUnspecified - * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_AttributeType_Freshness - * For the freshness use case the attribute value will be the duration - * between the current time and the date in the datetime field specified. - * The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: - * "FRESHNESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_AttributeType_Numerical - * The value of the numerical field will be used to dynamically update - * the boost amount. In this case, the attribute_value (the x value) of - * the control point will be the actual value of the numerical field for - * which the boost_amount is specified. (Value: "NUMERICAL") - */ -@property(nonatomic, copy, nullable) NSString *attributeType; +/** Document resource name. */ +@property(nonatomic, copy, nullable) NSString *document; -/** - * Optional. The control points used to define the curve. The monotonic - * function (defined through the interpolation_type above) passes through the - * control points listed here. - */ -@property(nonatomic, strong, nullable) NSArray *controlPoints; +/** Page identifier. */ +@property(nonatomic, copy, nullable) NSString *pageIdentifier; /** - * Optional. The name of the field whose value will be used to determine the - * boost amount. + * The structured JSON metadata for the document. It is populated from the + * struct data from the Chunk in search result. */ -@property(nonatomic, copy, nullable) NSString *fieldName; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata_StructData *structData; -/** - * Optional. The interpolation type to be applied to connect the control points - * listed below. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified - * Interpolation type is unspecified. In this case, it defaults to - * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_InterpolationType_Linear - * Piecewise linear interpolation will be applied. (Value: "LINEAR") - */ -@property(nonatomic, copy, nullable) NSString *interpolationType; +/** Title. */ +@property(nonatomic, copy, nullable) NSString *title; + +/** URI for the document. */ +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * The control points used to define the curve. The curve defined through these - * control points can only be monotonically increasing or decreasing(constant - * values are acceptable). + * The structured JSON metadata for the document. It is populated from the + * struct data from the Chunk in search result. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata_StructData : GTLRObject +@end -/** - * Optional. Can be one of: 1. The numerical field value. 2. The duration spec - * for freshness: The value must be formatted as an XSD `dayTimeDuration` value - * (a restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. - */ -@property(nonatomic, copy, nullable) NSString *attributeValue; /** - * Optional. The value between -1 to 1 by which to boost the score if the - * attribute_value evaluates to the value specified above. - * - * Uses NSNumber of floatValue. + * Structured search information. */ -@property(nonatomic, strong, nullable) NSNumber *boostAmount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo : GTLRObject + +/** Document resource name. */ +@property(nonatomic, copy, nullable) NSString *document; + +/** Structured search data. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo_StructData *structData; + +/** Output only. The title of the document. */ +@property(nonatomic, copy, nullable) NSString *title; + +/** Output only. The URI of the document. */ +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * Specified which products may be included in results. Uses same filter as - * boost. + * Structured search data. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlFilterAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo_StructData : GTLRObject +@end -/** - * Required. Specifies which data store's documents can be filtered by this - * control. Full data store name e.g. - * projects/123/locations/global/collections/default_collection/dataStores/default_data_store - */ -@property(nonatomic, copy, nullable) NSString *dataStore; /** - * Required. A filter to apply on the matching condition results. Required - * Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order - * Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is - * thrown. + * Unstructured document information. */ -@property(nonatomic, copy, nullable) NSString *filter; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo : GTLRObject -@end +/** List of cited chunk contents derived from document content. */ +@property(nonatomic, strong, nullable) NSArray *chunkContents; +/** Document resource name. */ +@property(nonatomic, copy, nullable) NSString *document; /** - * Promote certain links based on some trigger queries. Example: Promote shoe - * store link when searching for `shoe` keyword. The link can be outside of - * associated data store. + * The structured JSON metadata for the document. It is populated from the + * struct data from the Chunk in search result. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlPromoteAction : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo_StructData *structData; -/** Required. Data store with which this promotion is attached to. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +/** Title. */ +@property(nonatomic, copy, nullable) NSString *title; -/** Required. Promotion attached to this action. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion *searchLinkPromotion; +/** URI for the document. */ +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * Redirects a shopper to the provided URI. + * The structured JSON metadata for the document. It is populated from the + * struct data from the Chunk in search result. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlRedirectAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo_StructData : GTLRObject +@end + /** - * Required. The URI to which the shopper will be redirected. Required. URI - * must have length equal or less than 2000 characters. Otherwise an INVALID - * ARGUMENT error is thrown. + * Chunk content. */ -@property(nonatomic, copy, nullable) NSString *redirectUri; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent : GTLRObject + +/** + * Output only. Stores indexes of blobattachments linked to this chunk. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSArray *blobAttachmentIndexes; + +/** Chunk textual content. */ +@property(nonatomic, copy, nullable) NSString *content; + +/** Page identifier. */ +@property(nonatomic, copy, nullable) NSString *pageIdentifier; + +/** + * The relevance of the chunk for a given query. Values range from 0.0 + * (completely irrelevant) to 1.0 (completely relevant). This value is for + * informational purpose only. It may change for the same query and chunk at + * any time due to a model retraining or change in implementation. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *relevanceScore; @end /** - * Creates a set of terms that will act as synonyms of one another. Example: - * "happy" will also be considered as "glad", "glad" will also be considered as - * "happy". + * Step information. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlSynonymsAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep : GTLRObject + +/** Actions. */ +@property(nonatomic, strong, nullable) NSArray *actions; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at - * least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * The description of the step. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. */ -@property(nonatomic, strong, nullable) NSArray *synonyms; +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** + * The state of the step. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_Failed + * Step currently failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_InProgress + * Step is currently in progress. (Value: "IN_PROGRESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_StateUnspecified + * Unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStep_State_Succeeded + * Step has succeeded. (Value: "SUCCEEDED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** The thought of the step. */ +@property(nonatomic, copy, nullable) NSString *thought; @end /** - * The historical crawl rate timeseries data, used for monitoring. + * Action. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepAction : GTLRObject -/** The QPS of the crawl rate. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries *qpsTimeSeries; +/** Observation. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation *observation; + +/** Search action. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction *searchAction; @end /** - * Metadata related to the progress of the DataStoreService.CreateDataStore - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Observation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Search results observed by the search action, it can be snippets info or + * chunk info, depending on the citation type set by the user. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSArray *searchResults; @end /** - * Metadata related to the progress of the EngineService.CreateEngine - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate + * chunk info. + */ +@property(nonatomic, strong, nullable) NSArray *chunkInfo; + +/** Document resource name. */ +@property(nonatomic, copy, nullable) NSString *document; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level + * snippets. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSArray *snippetInfo; + +/** + * Data representation. The structured JSON data for the document. It's + * populated from the struct data from the Document, or the Chunk in search + * result. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult_StructData *structData; + +/** Title. */ +@property(nonatomic, copy, nullable) NSString *title; + +/** URI for the document. */ +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * Metadata for EvaluationService.CreateEvaluation method. + * Data representation. The structured JSON data for the document. It's + * populated from the struct data from the Document, or the Chunk in search + * result. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult_StructData : GTLRObject @end /** - * Metadata for Create Schema LRO. + * Chunk information. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Chunk resource name. */ +@property(nonatomic, copy, nullable) NSString *chunk; + +/** Chunk textual content. */ +@property(nonatomic, copy, nullable) NSString *content; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The relevance of the chunk for a given query. Values range from 0.0 + * (completely irrelevant) to 1.0 (completely relevant). This value is for + * informational purpose only. It may change for the same query and chunk at + * any time due to a model retraining or change in implementation. + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSNumber *relevanceScore; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.CreateSitemap operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Snippet information. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Snippet content. */ +@property(nonatomic, copy, nullable) NSString *snippet; -/** - * Operation last update time. If the operation is done, this is also the - * finish time. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +/** Status of the snippet defined by the search team. */ +@property(nonatomic, copy, nullable) NSString *snippetStatus; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.CreateTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Search action. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction : GTLRObject + +/** The query to search. */ +@property(nonatomic, copy, nullable) NSString *query; + +@end -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * AssistAnswer resource, main part of AssistResponse. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer : GTLRObject -@end +/** Reasons for not answering the assist call. */ +@property(nonatomic, strong, nullable) NSArray *assistSkippedReasons; +/** + * Optional. The field contains information about the various policy checks' + * results like the banned phrases or the Model Armor checks. This field is + * populated only if the assist call was skipped due to a policy violation. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult *customerPolicyEnforcementResult; /** - * Defines custom fine tuning spec. + * Immutable. Identifier. Resource name of the `AssistAnswer`. Format: + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` + * This field must be a UTF-8 encoded string with a length limit of 1024 + * characters. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *name; + +/** Replies of the assistant. */ +@property(nonatomic, strong, nullable) NSArray *replies; /** - * Whether or not to enable and include custom fine tuned search adaptor model. + * State of the answer generation. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Failed + * Assist operation has failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_InProgress + * Assist operation is currently in progress. (Value: "IN_PROGRESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Skipped + * Assist operation has been skipped. (Value: "SKIPPED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_StateUnspecified + * Unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer_State_Succeeded + * Assist operation has succeeded. (Value: "SUCCEEDED") */ -@property(nonatomic, strong, nullable) NSNumber *enableSearchAdaptor; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Manages the connection to external data sources for all data stores grouped - * under a Collection. It's a singleton resource of Collection. The - * initialization is only supported through - * DataConnectorService.SetUpDataConnector method, which will create a new - * Collection and initialize its DataConnector. + * Customer policy enforcement results. Contains the results of the various + * policy checks, like the banned phrases or the Model Armor checks. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult : GTLRObject /** - * Optional. Whether the connector will be created with an ACL config. - * Currently this field only affects Cloud Storage and BigQuery connectors. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *aclEnabled; - -/** Optional. Action configurations to make the connector support actions. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig *actionConfig; + * Customer policy enforcement results. Populated only if the assist call was + * skipped due to a policy violation. It contains results from those filters + * that blocked the processing of the query. + */ +@property(nonatomic, strong, nullable) NSArray *policyResults; /** - * Output only. State of the action connector. This reflects whether the action - * connector is initializing, active or has encountered errors. + * Final verdict of the customer policy enforcement. If only one policy blocked + * the processing, the verdict is BLOCK. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Active - * The connector is successfully set up and awaiting next sync run. - * (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Creating - * The connector is being set up. (Value: "CREATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Failed - * The connector is in error. The error details can be found in - * DataConnector.errors. If the error is unfixable, the DataConnector can - * be deleted by [CollectionService.DeleteCollection] API. (Value: - * "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_InitializationFailed - * Connector initialization failed. Potential causes include runtime - * errors or issues in the asynchronous pipeline, preventing the request - * from reaching downstream services (except for some connector types). - * (Value: "INITIALIZATION_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Running - * The connector is actively syncing records from the data source. - * (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_StateUnspecified - * Default value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Updating - * Connector is in the process of an update. (Value: "UPDATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Warning - * The connector has completed a sync run, but encountered non-fatal - * errors. (Value: "WARNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Allow + * There was no policy violation. (Value: "ALLOW") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Block + * Processing was blocked by the customer policy. (Value: "BLOCK") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult_Verdict_Unspecified + * Unknown value. (Value: "UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *actionState; +@property(nonatomic, copy, nullable) NSString *verdict; + +@end -/** Optional. The connector level alert config. */ -@property(nonatomic, strong, nullable) NSArray *alertPolicyConfigs; /** - * Optional. Indicates whether the connector is disabled for auto run. It can - * be used to pause periodical and real time sync. Update: with the - * introduction of incremental_sync_disabled, auto_run_disabled is used to - * pause/disable only full syncs - * - * Uses NSNumber of boolValue. + * Customer policy enforcement result for the banned phrase policy. */ -@property(nonatomic, strong, nullable) NSNumber *autoRunDisabled; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult : GTLRObject -/** Optional. The configuration for establishing a BAP connection. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig *bapConfig; +/** The banned phrases that were found in the query or the answer. */ +@property(nonatomic, strong, nullable) NSArray *bannedPhrases; -/** - * Output only. User actions that must be completed before the connector can - * start syncing data. - */ -@property(nonatomic, strong, nullable) NSArray *blockingReasons; +@end -/** - * Optional. The modes enabled for this connector. Default state is - * CONNECTOR_MODE_UNSPECIFIED. - */ -@property(nonatomic, strong, nullable) NSArray *connectorModes; /** - * Output only. The type of connector. Each source can only map to one type. - * For example, salesforce, confluence and jira have THIRD_PARTY connector - * type. It is not mutable once set by system. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_BigQuery - * Big query connector. (Value: "BIG_QUERY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ConnectorTypeUnspecified - * Default value. (Value: "CONNECTOR_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_Gcnv - * Google Cloud NetApp Volumes connector. (Value: "GCNV") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GcpFhir - * Data connector connects between FHIR store and VAIS datastore. (Value: - * "GCP_FHIR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_Gcs - * Google Cloud Storage connector. (Value: "GCS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GoogleCalendar - * Google Calendar connector. (Value: "GOOGLE_CALENDAR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GoogleDrive - * Google Drive connector. (Value: "GOOGLE_DRIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GoogleMail - * Gmail connector. (Value: "GOOGLE_MAIL") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_NativeCloudIdentity - * Native Cloud Identity connector for people search powered by People - * API. (Value: "NATIVE_CLOUD_IDENTITY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ThirdParty - * Third party connector to connector to third party application. (Value: - * "THIRD_PARTY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ThirdPartyEua - * Connector utilized for End User Authentication features. (Value: - * "THIRD_PARTY_EUA") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ThirdPartyFederated - * Federated connector, it is a third party connector that doesn't - * ingestion data, and search is powered by third party application's - * API. (Value: "THIRD_PARTY_FEDERATED") + * Customer policy enforcement result for the Model Armor policy. */ -@property(nonatomic, copy, nullable) NSString *connectorType; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult : GTLRObject /** - * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. - * - * Uses NSNumber of boolValue. + * The error returned by Model Armor if the policy enforcement failed for some + * reason. */ -@property(nonatomic, strong, nullable) NSNumber *createEuaSaas; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; -/** Output only. Timestamp the DataConnector was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** The Model Armor violation that was found. */ +@property(nonatomic, copy, nullable) NSString *modelArmorViolation; + +@end -/** - * Required. The name of the data source. Supported values: `salesforce`, - * `jira`, `confluence`, `bigquery`. - */ -@property(nonatomic, copy, nullable) NSString *dataSource; /** - * Optional. Any target destinations used to connect to third-party services. + * Customer policy enforcement result for a single policy type. */ -@property(nonatomic, strong, nullable) NSArray *destinationConfigs; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult : GTLRObject + +/** The policy enforcement result for the banned phrase policy. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult *bannedPhraseEnforcementResult; + +/** The policy enforcement result for the Model Armor policy. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult *modelArmorEnforcementResult; + +@end + /** - * Optional. Any params and credentials used specifically for EUA connectors. + * One part of the multi-part response of the assist call. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig *endUserConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswerReply : GTLRObject -/** List of entities from the connected data source to ingest. */ -@property(nonatomic, strong, nullable) NSArray *entities; +/** Possibly grounded response text or media from the assistant. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent *groundedContent; /** - * Output only. The errors from initialization or from the latest connector - * run. + * Output only. When set, uniquely identifies a reply within the `AssistAnswer` + * resource. During an AssistantService.StreamAssist call, multiple `Reply` + * messages with the same ID can occur within the response stream (across + * multiple AssistantService.StreamAssistResponse messages). These represent + * parts of a single `Reply` message in the final `AssistAnswer` resource. */ -@property(nonatomic, strong, nullable) NSArray *errors; +@property(nonatomic, copy, nullable) NSString *replyId; + +@end + /** - * Optional. Any params and credentials used specifically for hybrid connectors - * supporting FEDERATED mode. This field should only be set if the connector is - * a hybrid connector and we want to enable FEDERATED mode. + * Multi-modal content. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig *federatedConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContent : GTLRObject + +/** Result of executing an ExecutableCode. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult *codeExecutionResult; + +/** Code generated by the model that is meant to be executed. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode *executableCode; + +/** A file, e.g., an audio summary. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentFile *file; + +/** Inline binary data. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentBlob *inlineData; + +/** The producer of the content. Can be "model" or "user". */ +@property(nonatomic, copy, nullable) NSString *role; + +/** Inline text. */ +@property(nonatomic, copy, nullable) NSString *text; /** - * Optional. If the connector is a hybrid connector, determines whether - * ingestion is enabled and appropriate resources are provisioned during - * connector creation. If the connector is not a hybrid connector, this field - * is ignored. + * Optional. Indicates if the part is thought from the model. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *hybridIngestionDisabled; +@property(nonatomic, strong, nullable) NSNumber *thought; -/** - * The refresh interval to sync the Access Control List information for the - * documents ingested by this connector. If not set, the access control list - * will be refreshed at the default interval of 30 minutes. The identity - * refresh interval can be at least 30 minutes and at most 7 days. - */ -@property(nonatomic, strong, nullable) GTLRDuration *identityRefreshInterval GTLR_DEPRECATED; +@end -/** - * The configuration for the identity data synchronization runs. This contains - * the refresh interval to sync the Access Control List information for the - * documents ingested by this connector. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig *identityScheduleConfig; /** - * Optional. The refresh interval specifically for incremental data syncs. If - * unset, incremental syncs will use the default from env, set to 3hrs. The - * minimum is 30 minutes and maximum is 7 days. Applicable to only 3P - * connectors. When the refresh interval is set to the same value as the - * incremental refresh interval, incremental sync will be disabled. + * Inline blob. */ -@property(nonatomic, strong, nullable) GTLRDuration *incrementalRefreshInterval; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentBlob : GTLRObject /** - * Optional. Indicates whether incremental syncs are paused for this connector. - * This is independent of auto_run_disabled. Applicable to only 3P connectors. - * When the refresh interval is set to the same value as the incremental - * refresh interval, incremental sync will be disabled, i.e. set to true. + * Required. Raw bytes. * - * Uses NSNumber of boolValue. + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, strong, nullable) NSNumber *incrementalSyncDisabled; +@property(nonatomic, copy, nullable) NSString *data; -/** - * Input only. The KMS key to be used to protect the DataStores managed by this - * connector. Must be set for requests that need to comply with CMEK Org Policy - * protections. If this field is set and processed successfully, the DataStores - * created by this connector will be protected by the KMS key. - */ -@property(nonatomic, copy, nullable) NSString *kmsKeyName; +/** Required. The media type (MIME type) of the generated data. */ +@property(nonatomic, copy, nullable) NSString *mimeType; + +@end -/** - * Output only. For periodic connectors only, the last time a data sync was - * completed. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *lastSyncTime; /** - * Output only. The most recent timestamp when this DataConnector was paused, - * affecting all functionalities such as data synchronization. Pausing a - * connector has the following effects: - All functionalities, including data - * synchronization, are halted. - Any ongoing data synchronization job will be - * canceled. - No future data synchronization runs will be scheduled nor can be - * triggered. + * Result of executing ExecutableCode. */ -@property(nonatomic, strong, nullable) GTLRDateTime *latestPauseTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult : GTLRObject /** - * Output only. The full resource name of the Data Connector. Format: - * `projects/ * /locations/ * /collections/ * /dataConnector`. + * Required. Outcome of the code execution. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeDeadlineExceeded + * Code execution ran for too long, and was cancelled. There may or may + * not be a partial output present. (Value: "OUTCOME_DEADLINE_EXCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeFailed + * Code execution finished but with a failure. `stderr` should contain + * the reason. (Value: "OUTCOME_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeOk + * Code execution completed successfully. (Value: "OUTCOME_OK") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult_Outcome_OutcomeUnspecified + * Unspecified status. This value should not be used. (Value: + * "OUTCOME_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, copy, nullable) NSString *outcome; /** - * Defines the scheduled time for the next data synchronization. This field - * requires hour , minute, and time_zone from the [IANA Time Zone - * Database](https://www.iana.org/time-zones). This is utilized when the data - * connector has a refresh interval greater than 1 day. When the hours or - * minutes are not specified, we will assume a sync time of 0:00. The user must - * provide a time zone to avoid ambiguity. + * Optional. Contains stdout when code execution is successful, stderr or other + * description otherwise. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDateTime *nextSyncTime; +@property(nonatomic, copy, nullable) NSString *output; + +@end + /** - * Required. Params needed to access the source in the format of (Key, Value) - * pairs. Required parameters for all data sources: * Key: `instance_uri` * - * Value: type STRING. The uri to access the data source. Required parameters - * for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * - * Value: type STRING. The client ID for the third party service provider to - * identify your application. * Key: `client_secret` * Value:type STRING. The - * client secret generated by the third party authorization server. * Key: - * `access_token` * Value: type STRING. OAuth token for UCS to access to the - * protected resource. * Key: `refresh_token` * Value: type STRING. OAuth - * refresh token for UCS to obtain a new access token without user interaction. - * Required parameters for sources that support basic API token auth, i.e. - * `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The - * username or email with the source. * Key: `api_token` * Value: type STRING. - * The API token generated for the source account, that is used for - * authenticating anywhere where you would have used a password. Example: - * ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": - * "xxxx.xxx\@xxx.com", "api_token": "test-token" } ``` Optional parameter to - * specify the authorization type to use for multiple authorization types - * support: * Key: `auth_type` * Value: type STRING. The authorization type for - * the data source. Supported values: `BASIC_AUTH`, `OAUTH`, - * `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, - * `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. + * Code generated by the model that is meant to be executed by the model. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_Params *params; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode : GTLRObject -/** - * Output only. The tenant project ID associated with private connectivity - * connectors. This project must be allowlisted by in order for the connector - * to function. - */ -@property(nonatomic, copy, nullable) NSString *privateConnectivityProjectId; +/** Required. The code content. Currently only supports Python. */ +@property(nonatomic, copy, nullable) NSString *code; -/** - * Output only. real-time sync state - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Active - * The connector is successfully set up and awaiting next sync run. - * (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Creating - * The connector is being set up. (Value: "CREATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Failed - * The connector is in error. The error details can be found in - * DataConnector.errors. If the error is unfixable, the DataConnector can - * be deleted by [CollectionService.DeleteCollection] API. (Value: - * "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_InitializationFailed - * Connector initialization failed. Potential causes include runtime - * errors or issues in the asynchronous pipeline, preventing the request - * from reaching downstream services (except for some connector types). - * (Value: "INITIALIZATION_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Running - * The connector is actively syncing records from the data source. - * (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_StateUnspecified - * Default value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Updating - * Connector is in the process of an update. (Value: "UPDATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Warning - * The connector has completed a sync run, but encountered non-fatal - * errors. (Value: "WARNING") - */ -@property(nonatomic, copy, nullable) NSString *realtimeState; +@end -/** Optional. The configuration for realtime sync. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig *realtimeSyncConfig; /** - * Required. The refresh interval for data sync. If duration is set to 0, the - * data will be synced in real time. The streaming feature is not supported - * yet. The minimum is 30 minutes and maximum is 7 days. When the refresh - * interval is set to the same value as the incremental refresh interval, - * incremental sync will be disabled. + * A file, e.g., an audio summary. */ -@property(nonatomic, strong, nullable) GTLRDuration *refreshInterval; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContentFile : GTLRObject -/** - * Optional. Specifies keys to be removed from the 'params' field. This is only - * active when 'params' is included in the 'update_mask' in an - * UpdateDataConnectorRequest. Deletion takes precedence if a key is both in - * 'remove_param_keys' and present in the 'params' field of the request. - */ -@property(nonatomic, strong, nullable) NSArray *removeParamKeys; +/** Required. The file ID. */ +@property(nonatomic, copy, nullable) NSString *fileId; -/** - * Output only. State of the connector. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Active - * The connector is successfully set up and awaiting next sync run. - * (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Creating - * The connector is being set up. (Value: "CREATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Failed - * The connector is in error. The error details can be found in - * DataConnector.errors. If the error is unfixable, the DataConnector can - * be deleted by [CollectionService.DeleteCollection] API. (Value: - * "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_InitializationFailed - * Connector initialization failed. Potential causes include runtime - * errors or issues in the asynchronous pipeline, preventing the request - * from reaching downstream services (except for some connector types). - * (Value: "INITIALIZATION_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Running - * The connector is actively syncing records from the data source. - * (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_StateUnspecified - * Default value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Updating - * Connector is in the process of an update. (Value: "UPDATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Warning - * The connector has completed a sync run, but encountered non-fatal - * errors. (Value: "WARNING") - */ -@property(nonatomic, copy, nullable) NSString *state; +/** Required. The media type (MIME type) of the file. */ +@property(nonatomic, copy, nullable) NSString *mimeType; -/** Output only. The static IP addresses used by this connector. */ -@property(nonatomic, strong, nullable) NSArray *staticIpAddresses; +@end -/** - * Optional. Whether customer has enabled static IP addresses for this - * connector. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *staticIpEnabled; /** - * The data synchronization mode supported by the data connector. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_SyncMode_Periodic - * The connector will sync data periodically based on the - * refresh_interval. Use it with auto_run_disabled to pause the periodic - * sync, or indicate a one-time sync. (Value: "PERIODIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_SyncMode_Streaming - * The data will be synced in real time. (Value: "STREAMING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_SyncMode_Unspecified - * Connector that doesn't ingest data will have this value (Value: - * "UNSPECIFIED") + * A piece of content and possibly its grounding information. Not all content + * needs grounding. Phrases like "Of course, I will gladly search it for you." + * do not need grounding. */ -@property(nonatomic, copy, nullable) NSString *syncMode; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent : GTLRObject -/** Output only. Timestamp the DataConnector was last updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +/** The content. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantContent *content; + +/** Metadata for grounding based on text sources. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata *textGroundingMetadata; @end /** - * Required. Params needed to access the source in the format of (Key, Value) - * pairs. Required parameters for all data sources: * Key: `instance_uri` * - * Value: type STRING. The uri to access the data source. Required parameters - * for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * - * Value: type STRING. The client ID for the third party service provider to - * identify your application. * Key: `client_secret` * Value:type STRING. The - * client secret generated by the third party authorization server. * Key: - * `access_token` * Value: type STRING. OAuth token for UCS to access to the - * protected resource. * Key: `refresh_token` * Value: type STRING. OAuth - * refresh token for UCS to obtain a new access token without user interaction. - * Required parameters for sources that support basic API token auth, i.e. - * `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The - * username or email with the source. * Key: `api_token` * Value: type STRING. - * The API token generated for the source account, that is used for - * authenticating anywhere where you would have used a password. Example: - * ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": - * "xxxx.xxx\@xxx.com", "api_token": "test-token" } ``` Optional parameter to - * specify the authorization type to use for multiple authorization types - * support: * Key: `auth_type` * Value: type STRING. The authorization type for - * the data source. Supported values: `BASIC_AUTH`, `OAUTH`, - * `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, - * `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Grounding details for text sources. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_Params : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata : GTLRObject + +/** References for the grounded text. */ +@property(nonatomic, strong, nullable) NSArray *references; + +/** Grounding information for parts of the text. */ +@property(nonatomic, strong, nullable) NSArray *segments; + @end /** - * Any params and credentials used specifically for EUA connectors. + * Referenced content and related document metadata. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig : GTLRObject - -/** Optional. Any additional parameters needed for EUA. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AdditionalParams *additionalParams; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference : GTLRObject -/** Optional. Any authentication parameters specific to EUA connectors. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AuthParams *authParams; +/** Referenced text content. */ +@property(nonatomic, copy, nullable) NSString *content; -/** Optional. The tenant project the connector is connected to. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTenant *tenant; +/** Document metadata. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata *documentMetadata; @end /** - * Optional. Any additional parameters needed for EUA. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Document metadata. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AdditionalParams : GTLRObject -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata : GTLRObject +/** Document resource name. */ +@property(nonatomic, copy, nullable) NSString *document; /** - * Optional. Any authentication parameters specific to EUA connectors. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Domain name from the document URI. Note that the `uri` field may contain a + * URL that redirects to the actual website, in which case this will contain + * the domain name of the target site. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AuthParams : GTLRObject -@end - +@property(nonatomic, copy, nullable) NSString *domain; /** - * Any params and credentials used specifically for hybrid connectors - * supporting FEDERATED mode. + * The mime type of the document. + * https://www.iana.org/assignments/media-types/media-types.xhtml. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *mimeType; -/** Optional. Any additional parameters needed for FEDERATED. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AdditionalParams *additionalParams; +/** Page identifier. */ +@property(nonatomic, copy, nullable) NSString *pageIdentifier; -/** Optional. Any authentication parameters specific to FEDERATED. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AuthParams *authParams; +/** Title. */ +@property(nonatomic, copy, nullable) NSString *title; + +/** + * URI for the document. It may contain a URL that redirects to the actual + * website. + */ +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * Optional. Any additional parameters needed for FEDERATED. + * Grounding information for a segment of the text. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment : GTLRObject + +/** + * End of the segment, exclusive. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AdditionalParams : GTLRObject -@end +@property(nonatomic, strong, nullable) NSNumber *endIndex; +/** + * Score for the segment. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *groundingScore; /** - * Optional. Any authentication parameters specific to FEDERATED. + * References for the segment. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AuthParams : GTLRObject +@property(nonatomic, strong, nullable) NSArray *referenceIndices; + +/** + * Zero-based index indicating the start of the segment, measured in bytes of a + * UTF-8 string (i.e. characters encoded on multiple bytes have a length of + * more than one). + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *startIndex; + +/** The text segment itself. */ +@property(nonatomic, copy, nullable) NSString *text; + @end /** - * The configuration for realtime sync to store additional params for realtime - * sync. + * The configuration for the BAP connector. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig : GTLRObject - -/** Optional. The ID of the Secret Manager secret used for webhook secret. */ -@property(nonatomic, copy, nullable) NSString *realtimeSyncSecret; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig : GTLRObject -/** Optional. Streaming error details. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError *streamingError; +/** Optional. The actions enabled on the associated BAP connection. */ +@property(nonatomic, strong, nullable) NSArray *enabledActions; /** - * Optional. Webhook url for the connector to specify additional params for - * realtime sync. + * Required. The supported connector modes for the associated BAP connection. */ -@property(nonatomic, copy, nullable) NSString *webhookUri; +@property(nonatomic, strong, nullable) NSArray *supportedConnectorModes; @end /** - * Streaming error details. + * Metadata related to the progress of the + * SiteSearchEngineService.BatchCreateTargetSites operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata : GTLRObject -/** Optional. Error details. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. Streaming error. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_IngressEndpointRequired - * Ingress endpoint is required when setting up realtime sync in private - * connectivity. (Value: "INGRESS_ENDPOINT_REQUIRED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingErrorReasonUnspecified - * Streaming error reason unspecified. (Value: - * "STREAMING_ERROR_REASON_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSetupError - * Some error occurred while setting up resources for realtime sync. - * (Value: "STREAMING_SETUP_ERROR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError - * Some error was encountered while running realtime sync for the - * connector. (Value: "STREAMING_SYNC_ERROR") + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *streamingErrorReason; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Represents an entity in the data source. For example, the `Account` object - * in Salesforce. + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse : GTLRObject + +/** TargetSites created. */ +@property(nonatomic, strong, nullable) NSArray *targetSites; + +@end -/** - * Output only. The full resource name of the associated data store for the - * source entity. Format: `projects/ * /locations/ * /collections/ * - * /dataStores/ *`. When the connector is initialized by the - * DataConnectorService.SetUpDataConnector method, a DataStore is automatically - * created for each source entity. - */ -@property(nonatomic, copy, nullable) NSString *dataStore; /** - * The name of the entity. Supported values by data source: * Salesforce: - * `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` - * * Jira: `Issue` * Confluence: `Content`, `Space` - * - * Remapped to 'entityNameProperty' to avoid NSObject's 'entityName'. + * Metadata related to the progress of the + * UserLicenseService.BatchUpdateUserLicenses operation. This will be returned + * by the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *entityNameProperty; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata : GTLRObject -/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig *healthcareFhirConfig; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Attributes for indexing. Key: Field name. Value: The key property to map a - * field to, such as `title`, and `description`. Supported key properties: * - * `title`: The title for data record. This would be displayed on search - * results. * `description`: The description for data record. This would be - * displayed on search results. + * Count of user licenses that failed to be updated. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_KeyPropertyMappings *keyPropertyMappings; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * The parameters for the entity to facilitate data ingestion. E.g. for - * BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The - * value of the column ID. + * Count of user licenses successfully updated. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_Params *params; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Optional. The start schema to use for the DataStore created from this - * SourceEntity. If unset, a default vertical specialized schema will be used. - * This field is only used by SetUpDataConnector API, and will be ignored if - * used in other APIs. This field will be omitted from all API responses - * including GetDataConnector API. To retrieve a schema of a DataStore, use - * SchemaService.GetSchema API instead. The provided schema will be validated - * against certain rules on schema. Learn more from [this - * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema *startingSchema; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Attributes for indexing. Key: Field name. Value: The key property to map a - * field to, such as `title`, and `description`. Supported key properties: * - * `title`: The title for data record. This would be displayed on search - * results. * `description`: The description for data record. This would be - * displayed on search results. - * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Response message for UserLicenseService.BatchUpdateUserLicenses method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_KeyPropertyMappings : GTLRObject -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse : GTLRObject +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** UserLicenses successfully updated. */ +@property(nonatomic, strong, nullable) NSArray *userLicenses; -/** - * The parameters for the entity to facilitate data ingestion. E.g. for - * BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The - * value of the column ID. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_Params : GTLRObject @end /** - * DataStore captures global settings and configs at the DataStore level. + * Configurations used to enable CMEK data encryption with Cloud KMS keys. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig : GTLRObject /** - * Immutable. Whether data in the DataStore has ACL information. If set to - * `true`, the source data must have ACL. ACL will be ingested when data is - * ingested by DocumentService.ImportDocuments methods. When ACL is enabled for - * the DataStore, Document can't be accessed by calling - * DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL - * is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` - * content config. + * Output only. The default CmekConfig for the Customer. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *aclEnabled; - -/** Optional. Configuration for advanced site search. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig *advancedSiteSearchConfig; - -/** Output only. Data size estimation for billing. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation *billingEstimation; - -/** Output only. CMEK-related information for the DataStore. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig *cmekConfig; +@property(nonatomic, strong, nullable) NSNumber *isDefault; /** - * Immutable. The content config of the data store. If this field is unset, the - * server behavior defaults to ContentConfig.NO_CONTENT. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_ContentConfigUnspecified - * Default value. (Value: "CONTENT_CONFIG_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_ContentRequired - * Only contains documents with Document.content. (Value: - * "CONTENT_REQUIRED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_GoogleWorkspace - * The data store is used for workspace search. Details of workspace data - * store are specified in the WorkspaceConfig. (Value: - * "GOOGLE_WORKSPACE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_NoContent - * Only contains documents without any Document.content. (Value: - * "NO_CONTENT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_PublicWebsite - * The data store is used for public website search. (Value: - * "PUBLIC_WEBSITE") + * Required. KMS key resource name which will be used to encrypt resources + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */ -@property(nonatomic, copy, nullable) NSString *contentConfig; - -/** Output only. Timestamp the DataStore was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, copy, nullable) NSString *kmsKey; /** - * Output only. The id of the default Schema associated to this data store. + * Output only. KMS key version resource name which will be used to encrypt + * resources `/cryptoKeyVersions/{keyVersion}`. */ -@property(nonatomic, copy, nullable) NSString *defaultSchemaId; +@property(nonatomic, copy, nullable) NSString *kmsKeyVersion; /** - * Required. The data store display name. This field must be a UTF-8 encoded - * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT - * error is returned. + * Output only. The timestamp of the last key rotation. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Configuration for Document understanding and enrichment. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig *documentProcessingConfig; - -/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig *healthcareFhirConfig; +@property(nonatomic, strong, nullable) NSNumber *lastRotationTimestampMicros; /** - * Immutable. The fully qualified resource name of the associated - * IdentityMappingStore. This field can only be set for acl_enabled DataStores - * with `THIRD_PARTY` or `GSUITE` IdP. Format: - * `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. + * Required. The name of the CmekConfig of the form + * `projects/{project}/locations/{location}/cmekConfig` or + * `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. */ -@property(nonatomic, copy, nullable) NSString *identityMappingStore; - -/** Output only. Data store level identity provider config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig *idpConfig; +@property(nonatomic, copy, nullable) NSString *name; /** - * Immutable. The industry vertical that the data store registers. + * Output only. Whether the NotebookLM Corpus is ready to be used. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_Generic - * The generic vertical for documents that are not specific to any - * industry vertical. (Value: "GENERIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_HealthcareFhir - * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_IndustryVerticalUnspecified - * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_Media - * The media industry vertical. (Value: "MEDIA") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmNotEnabled + * The NotebookLM is not enabled. (Value: "NOTEBOOK_LM_NOT_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmNotReady + * The NotebookLM is not ready. (Value: "NOTEBOOK_LM_NOT_READY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmReady + * The NotebookLM is ready to be used. (Value: "NOTEBOOK_LM_READY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_NotebooklmState_NotebookLmStateUnspecified + * The NotebookLM state is unknown. (Value: + * "NOTEBOOK_LM_STATE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *industryVertical; +@property(nonatomic, copy, nullable) NSString *notebooklmState; /** - * Optional. If set, this DataStore is an Infobot FAQ DataStore. - * - * Uses NSNumber of boolValue. + * Optional. Single-regional CMEKs that are required for some VAIS features. */ -@property(nonatomic, strong, nullable) NSNumber *isInfobotFaqDataStore; +@property(nonatomic, strong, nullable) NSArray *singleRegionKeys; /** - * Input only. The KMS key to be used to protect this DataStore at creation - * time. Must be set for requests that need to comply with CMEK Org Policy - * protections. If this field is set and processed successfully, the DataStore - * will be protected by the KMS key, as indicated in the cmek_config field. + * Output only. The states of the CmekConfig. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Active + * The CmekConfig can be used with DataStores. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_ActiveRotating + * The KMS key version is being rotated. (Value: "ACTIVE_ROTATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Creating + * The CmekConfig is creating. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleted + * The KMS key is soft deleted. Some cleanup policy will eventually be + * applied. (Value: "DELETED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_DeleteFailed + * The CmekConfig deletion process failed. (Value: "DELETE_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Deleting + * The CmekConfig is deleting. (Value: "DELETING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Expired + * The KMS key is expired, meaning the key has been disabled for 30+ + * days. The customer can call DeleteCmekConfig to change the state to + * DELETED. (Value: "EXPIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_KeyIssue + * The CmekConfig is unavailable, most likely due to the KMS Key being + * revoked. (Value: "KEY_ISSUE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_StateUnspecified + * The CmekConfig state is unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig_State_Unusable + * The CmekConfig is not usable, most likely due to some internal issue. + * (Value: "UNUSABLE") */ -@property(nonatomic, copy, nullable) NSString *kmsKeyName; +@property(nonatomic, copy, nullable) NSString *state; + +@end -/** Language info for DataStore. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLanguageInfo *languageInfo; /** - * Immutable. Identifier. The full resource name of the data store. Format: - * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - * This field must be a UTF-8 encoded string with a length limit of 1024 - * characters. + * Collection is a container for configuring resources and access to a set of + * DataStores. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCollection : GTLRObject -/** Optional. Configuration for Natural Language Query Understanding. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig *naturalLanguageQueryUnderstandingConfig; - -/** Optional. Stores serving config at DataStore level. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore *servingConfigDataStore; +/** Output only. Timestamp the Collection was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The solutions that the data store enrolls. Available solutions for each - * industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and - * `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is - * automatically enrolled. Other solutions cannot be enrolled. + * Output only. The data connector, if present, manages the connection for data + * stores in the Collection. To set up the connector, use + * DataConnectorService.SetUpDataConnector method, which creates a new + * Collection while setting up the DataConnector singleton resource. Setting up + * connector on an existing Collection is not supported. This output only field + * contains a subset of the DataConnector fields, including `name`, + * `data_source`, `entities.entity_name` and `entities.data_store`. To get more + * details about a data connector, use the + * DataConnectorService.GetDataConnector method. */ -@property(nonatomic, strong, nullable) NSArray *solutionTypes; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector *dataConnector; /** - * The start schema to use for this DataStore when provisioning it. If unset, a - * default vertical specialized schema will be used. This field is only used by - * CreateDataStore API, and will be ignored if used in other APIs. This field - * will be omitted from all API responses including CreateDataStore API. To - * retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. - * The provided schema will be validated against certain rules on schema. Learn - * more from [this - * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + * Required. The Collection display name. This field must be a UTF-8 encoded + * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT + * error is returned. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema *startingSchema; +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Config to store data store type configuration for workspace data. This must - * be set when DataStore.content_config is set as - * DataStore.ContentConfig.GOOGLE_WORKSPACE. + * Immutable. The full resource name of the Collection. Format: + * `projects/{project}/locations/{location}/collections/{collection_id}`. This + * field must be a UTF-8 encoded string with a length limit of 1024 characters. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaWorkspaceConfig *workspaceConfig; +@property(nonatomic, copy, nullable) NSString *name; @end /** - * Estimation of data size per data store. + * Defines circumstances to be checked before allowing a behavior */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCondition : GTLRObject /** - * Data size for structured data in terms of bytes. - * - * Uses NSNumber of longLongValue. + * Range of time(s) specifying when condition is active. Maximum of 10 time + * ranges. */ -@property(nonatomic, strong, nullable) NSNumber *structuredDataSize; - -/** Last updated timestamp for structured data. */ -@property(nonatomic, strong, nullable) GTLRDateTime *structuredDataUpdateTime; +@property(nonatomic, strong, nullable) NSArray *activeTimeRange; /** - * Data size for unstructured data in terms of bytes. - * - * Uses NSNumber of longLongValue. + * Optional. Query regex to match the whole search query. Cannot be set when + * Condition.query_terms is set. Only supported for Basic Site Search promotion + * serving controls. */ -@property(nonatomic, strong, nullable) NSNumber *unstructuredDataSize; - -/** Last updated timestamp for unstructured data. */ -@property(nonatomic, strong, nullable) GTLRDateTime *unstructuredDataUpdateTime; +@property(nonatomic, copy, nullable) NSString *queryRegex; /** - * Data size for websites in terms of bytes. - * - * Uses NSNumber of longLongValue. + * Search only A list of terms to match the query on. Cannot be set when + * Condition.query_regex is set. Maximum of 10 query terms. */ -@property(nonatomic, strong, nullable) NSNumber *websiteDataSize; - -/** Last updated timestamp for websites. */ -@property(nonatomic, strong, nullable) GTLRDateTime *websiteDataUpdateTime; +@property(nonatomic, strong, nullable) NSArray *queryTerms; @end /** - * Stores information regarding the serving configurations at DataStore level. + * Matcher for search request query */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionQueryTerm : GTLRObject /** - * Optional. If set true, the DataStore will not be available for serving - * search requests. + * Whether the search query needs to exactly match the query term. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *disabledForServing; - -@end - +@property(nonatomic, strong, nullable) NSNumber *fullMatch; /** - * The historical dedicated crawl rate timeseries data, used for monitoring. - * Dedicated crawl is used by Vertex AI to crawl the user's website when - * dedicate crawl is set. + * The specific query value to match against Must be lowercase, must be UTF-8. + * Can have at most 3 space separated terms if full_match is true. Cannot be an + * empty string. Maximum length of 5000 characters. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries : GTLRObject +@property(nonatomic, copy, nullable) NSString *value; + +@end -/** Vertex AI's error rate time series of auto-refresh dedicated crawl. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *autoRefreshCrawlErrorRate; /** - * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the - * crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the - * crawl rate is for best effort use cases like refreshing urls periodically. + * Used for time-dependent conditions. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *autoRefreshCrawlRate; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConditionTimeRange : GTLRObject -/** Vertex AI's error rate time series of user triggered dedicated crawl. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *userTriggeredCrawlErrorRate; +/** End of time range. Range is inclusive. Must be in the future. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; -/** - * Vertex AI's dedicated crawl rate time series of user triggered crawl, which - * is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and - * user triggered crawl rate is for deterministic use cases like crawling urls - * or sitemaps specified by users. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *userTriggeredCrawlRate; +/** Start of time range. Range is inclusive. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; @end /** - * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * A data sync run of DataConnector. After DataConnector is successfully + * initialized, data syncs are scheduled at DataConnector.refresh_interval. A + * ConnectorRun represents a data sync either in the past or onging that the + * moment. // */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Output only. The time when the connector run ended. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Output only. The details of the entities synced at the ConnectorRun. Each + * ConnectorRun consists of syncing one or more entities. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) NSArray *entityRuns; /** - * Metadata related to the progress of the CollectionService.UpdateCollection - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Contains info about errors incurred during the sync. Only exist if running + * into an error state. Contains error code and error message. Use with the + * `state` field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata : GTLRObject +@property(nonatomic, strong, nullable) NSArray *errors; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Output only. The time when the connector run was most recently paused. */ +@property(nonatomic, strong, nullable) GTLRDateTime *latestPauseTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Output only. The full resource name of the Connector Run. Format: `projects/ + * * /locations/ * /collections/ * /dataConnector/connectorRuns/ *`. The + * `connector_run_id` is system-generated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, copy, nullable) NSString *name; +/** Output only. The time when the connector run started. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Output only. The state of the sync run. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Cancelled + * Data sync was scheduled but has been cancelled. (Value: "CANCELLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Failed + * The data sync is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Overrun + * Data sync has been running longer than expected and is still running + * at the time the next run is supposed to start. (Value: "OVERRUN") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Pending + * Data sync is about to start. (Value: "PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Running + * The data sync is ongoing. (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Skipped + * An ongoing connector run has been running longer than expected, + * causing this run to be skipped. (Value: "SKIPPED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Succeeded + * The data sync is finished. (Value: "SUCCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_State_Warning + * The data sync completed with non-fatal errors. (Value: "WARNING") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *state; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Timestamp at which the connector run sync state was last updated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *stateUpdateTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Output only. The trigger for this ConnectorRun. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Initialization + * ConnectorRun auto triggered by connector initialization. (Value: + * "INITIALIZATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Manual + * ConnectorRun triggered by user manually. (Value: "MANUAL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Resume + * ConnectorRun auto triggered by resuming connector. (Value: "RESUME") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_Scheduler + * ConnectorRun triggered by scheduler if connector has PERIODIC sync + * mode. (Value: "SCHEDULER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRun_Trigger_TriggerUnspecified + * Default value. (Value: "TRIGGER_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *trigger; @end /** - * Metadata related to the progress of the EngineService.DeleteEngine - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Represents an entity that was synced in this ConnectorRun. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The number of documents deleted. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) NSNumber *deletedRecordCount; /** - * Metadata related to the progress of the - * IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will - * be returned by the google.longrunning.Operation.metadata field. + * The name of the source entity. + * + * Remapped to 'entityNameProperty' to avoid NSObject's 'entityName'. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, copy, nullable) NSString *entityNameProperty; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The total number of documents failed at sync at indexing stage. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) NSNumber *errorRecordCount; /** - * Metadata for DeleteSchema LRO. + * The errors from the entity's sync run. Only exist if running into an error + * state. Contains error code and error message. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) NSArray *errors; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The number of documents extracted from connector source, ready to + * be ingested to VAIS. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSNumber *extractedRecordCount; -@end +/** + * Optional. The number of documents indexed. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *indexedRecordCount; +/** Metadata to generate the progress bar. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress *progress; /** - * Request for DeleteSession method. + * Optional. The number of documents scheduled to be crawled/extracted from + * connector source. This only applies to third party connectors. + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *scheduledRecordCount; /** - * Required. The resource name of the Session to delete. Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * Optional. The number of requests sent to 3p API. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSNumber *sourceApiRequestCount; -@end +/** + * The state of the entity's sync run. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Cancelled + * Data sync was scheduled but has been cancelled. (Value: "CANCELLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Failed + * The data sync is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Overrun + * Data sync has been running longer than expected and is still running + * at the time the next run is supposed to start. (Value: "OVERRUN") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Pending + * Data sync is about to start. (Value: "PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Running + * The data sync is ongoing. (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Skipped + * An ongoing connector run has been running longer than expected, + * causing this run to be skipped. (Value: "SKIPPED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Succeeded + * The data sync is finished. (Value: "SUCCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_State_Warning + * The data sync completed with non-fatal errors. (Value: "WARNING") + */ +@property(nonatomic, copy, nullable) NSString *state; +/** Timestamp at which the entity sync state was last updated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *stateUpdateTime; /** - * Metadata related to the progress of the - * SiteSearchEngineService.DeleteSitemap operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * The timestamp for either extracted_documents_count, indexed_documents_count + * and error_documents_count was last updated. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDateTime *statsUpdateTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Sync type of this run. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_Full + * Sync triggers full sync of all documents. (Value: "FULL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_Incremental + * Incremental sync of updated documents. (Value: "INCREMENTAL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_Realtime + * Realtime sync. (Value: "REALTIME") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_ScalaSync + * Scala sync. (Value: "SCALA_SYNC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun_SyncType_SyncTypeUnspecified + * Sync type unspecified. (Value: "SYNC_TYPE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *syncType; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.DeleteTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Represents the progress of a sync run. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The current progress. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, strong, nullable) NSNumber *currentCount; +/** + * Derived. The percentile of the progress.current_count / total_count. The + * value is between [0, 1.0] inclusive. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *percentile; /** - * Defines target endpoints used to connect to third-party sources. + * The total. + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *totalCount; + +@end -/** Optional. The destinations for the corresponding key. */ -@property(nonatomic, strong, nullable) NSArray *destinations; /** - * Optional. Unique destination identifier that is supported by the connector. + * The contact info stored in resource level. If both project level and + * resource level is populated, the resource level contact info will override + * the project level contact info. */ -@property(nonatomic, copy, nullable) NSString *key; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaContactDetails : GTLRObject -/** Optional. Additional parameters for this destination config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig_Params *params; +/** Optional. The email address of the contact. */ +@property(nonatomic, copy, nullable) NSString *emailAddress; @end /** - * Optional. Additional parameters for this destination config. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Defines a conditioned behavior to employ during serving. Must be attached to + * a ServingConfig to be considered at serving time. Permitted actions + * dependent on `SolutionType`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig_Params : GTLRObject -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl : GTLRObject /** - * Defines a target endpoint + * Output only. List of all ServingConfig IDs this control is attached to. May + * take up to 10 minutes to update after changes. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination : GTLRObject +@property(nonatomic, strong, nullable) NSArray *associatedServingConfigIds; -/** Publicly routable host. */ -@property(nonatomic, copy, nullable) NSString *host; +/** Defines a boost-type control */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction *boostAction; /** - * Optional. Target port number accepted by the destination. - * - * Uses NSNumber of intValue. + * Determines when the associated action will trigger. Omit to always apply the + * action. Currently only a single condition may be specified. Otherwise an + * INVALID ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSNumber *port; +@property(nonatomic, strong, nullable) NSArray *conditions; -@end +/** + * Required. Human readable name. The identifier used in UI views. Must be + * UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID + * ARGUMENT error is thrown. + */ +@property(nonatomic, copy, nullable) NSString *displayName; +/** Defines a filter-type control Currently not supported by Recommendation */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlFilterAction *filterAction; /** - * Metadata related to the progress of the - * SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Immutable. Fully qualified name `projects/ * /locations/global/dataStore/ * + * /controls/ *` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *name; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Promote certain links based on predefined trigger queries. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlPromoteAction *promoteAction; + +/** Defines a redirect-type control. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlRedirectAction *redirectAction; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Required. Immutable. What solution the control belongs to. Must be + * compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is + * thrown. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeChat + * Used for use cases related to the Generative AI agent. (Value: + * "SOLUTION_TYPE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeGenerativeChat + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled + * with `SOLUTION_TYPE_CHAT` solution. (Value: + * "SOLUTION_TYPE_GENERATIVE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeRecommendation + * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeSearch + * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControl_SolutionType_SolutionTypeUnspecified + * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, copy, nullable) NSString *solutionType; +/** Treats a group of terms as synonyms of one another. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlSynonymsAction *synonymsAction; /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch - * method. + * Specifies the use case for the control. Affects what condition fields can be + * set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case + * per control. Must be set when solution_type is + * SolutionType.SOLUTION_TYPE_SEARCH. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse : GTLRObject +@property(nonatomic, strong, nullable) NSArray *useCases; + @end /** - * A singleton resource of DataStore. If it's empty when DataStore is created - * and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the - * default parser will default to digital parser. + * Adjusts order of products in returned list. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostAction : GTLRObject -/** Whether chunking mode is enabled. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig *chunkingConfig; +/** + * Strength of the boost, which should be in [-1, 1]. Negative boost means + * demotion. Default is 0.0 (No-op). + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *boost GTLR_DEPRECATED; /** - * Configurations for default Document parser. If not specified, we will - * configure it as default DigitalParsingConfig, and the default parsing config - * will be applied to all file types for Document parsing. + * Required. Specifies which data store's documents can be boosted by this + * control. Full data store name e.g. + * projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig *defaultParsingConfig; +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * The full resource name of the Document Processing Config. Format: `projects/ - * * /locations/ * /collections/ * /dataStores/ * /documentProcessingConfig`. + * Required. Specifies which products to apply the boost to. If no filter is + * provided all products will be boosted (No-op). Syntax documentation: + * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 + * characters. Otherwise an INVALID ARGUMENT error is thrown. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, copy, nullable) NSString *filter; /** - * Map from file type to override the default parsing configuration based on - * the file type. Supported keys: * `pdf`: Override parsing config for PDF - * files, either digital parsing, ocr parsing or layout parsing is supported. * - * `html`: Override parsing config for HTML files, only digital parsing and - * layout parsing are supported. * `docx`: Override parsing config for DOCX - * files, only digital parsing and layout parsing are supported. * `pptx`: - * Override parsing config for PPTX files, only digital parsing and layout - * parsing are supported. * `xlsm`: Override parsing config for XLSM files, - * only digital parsing and layout parsing are supported. * `xlsx`: Override - * parsing config for XLSX files, only digital parsing and layout parsing are - * supported. + * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost + * means demotion. Default is 0.0 (No-op). + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig_ParsingConfigOverrides *parsingConfigOverrides; +@property(nonatomic, strong, nullable) NSNumber *fixedBoost; + +/** + * Optional. Complex specification for custom ranking based on customer defined + * attribute value. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec *interpolationBoostSpec; @end /** - * Map from file type to override the default parsing configuration based on - * the file type. Supported keys: * `pdf`: Override parsing config for PDF - * files, either digital parsing, ocr parsing or layout parsing is supported. * - * `html`: Override parsing config for HTML files, only digital parsing and - * layout parsing are supported. * `docx`: Override parsing config for DOCX - * files, only digital parsing and layout parsing are supported. * `pptx`: - * Override parsing config for PPTX files, only digital parsing and layout - * parsing are supported. * `xlsm`: Override parsing config for XLSM files, - * only digital parsing and layout parsing are supported. * `xlsx`: Override - * parsing config for XLSX files, only digital parsing and layout parsing are - * supported. + * Specification for custom ranking based on customer specified attribute + * value. It provides more controls for customized ranking than the simple + * (condition, boost) combination above. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec : GTLRObject + +/** + * Optional. The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness however, + * attribute_value = (time.now() - datetime_field_value). * - * @note This class is documented as having more properties of - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig. - * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get - * the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_AttributeType_AttributeTypeUnspecified + * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_AttributeType_Freshness + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field specified. + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: + * "FRESHNESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_AttributeType_Numerical + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) of + * the control point will be the actual value of the numerical field for + * which the boost_amount is specified. (Value: "NUMERICAL") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig_ParsingConfigOverrides : GTLRObject -@end +@property(nonatomic, copy, nullable) NSString *attributeType; +/** + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through the + * control points listed here. + */ +@property(nonatomic, strong, nullable) NSArray *controlPoints; /** - * Configuration for chunking config. + * Optional. The name of the field whose value will be used to determine the + * boost amount. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *fieldName; -/** Configuration for the layout based chunking. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig *layoutBasedChunkingConfig; +/** + * Optional. The interpolation type to be applied to connect the control points + * listed below. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified + * Interpolation type is unspecified. In this case, it defaults to + * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec_InterpolationType_Linear + * Piecewise linear interpolation will be applied. (Value: "LINEAR") + */ +@property(nonatomic, copy, nullable) NSString *interpolationType; @end /** - * Configuration for the layout based chunking. + * The control points used to define the curve. The curve defined through these + * control points can only be monotonically increasing or decreasing(constant + * values are acceptable). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint : GTLRObject /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). - * Default value: 500. - * - * Uses NSNumber of intValue. + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec + * for freshness: The value must be formatted as an XSD `dayTimeDuration` value + * (a restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. */ -@property(nonatomic, strong, nullable) NSNumber *chunkSize; +@property(nonatomic, copy, nullable) NSString *attributeValue; /** - * Whether to include appending different levels of headings to chunks from the - * middle of the document to prevent context loss. Default value: False. + * Optional. The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. * - * Uses NSNumber of boolValue. + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *includeAncestorHeadings; +@property(nonatomic, strong, nullable) NSNumber *boostAmount; @end /** - * Related configurations applied to a specific type of document parser. + * Specified which products may be included in results. Uses same filter as + * boost. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig : GTLRObject - -/** Configurations applied to digital parser. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig *digitalParsingConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlFilterAction : GTLRObject -/** Configurations applied to layout parser. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig *layoutParsingConfig; +/** + * Required. Specifies which data store's documents can be filtered by this + * control. Full data store name e.g. + * projects/123/locations/global/collections/default_collection/dataStores/default_data_store + */ +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * Required. A filter to apply on the matching condition results. Required + * Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order + * Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is + * thrown. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig *ocrParsingConfig; +@property(nonatomic, copy, nullable) NSString *filter; @end /** - * The digital parsing configurations for documents. + * Promote certain links based on some trigger queries. Example: Promote shoe + * store link when searching for `shoe` keyword. The link can be outside of + * associated data store. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlPromoteAction : GTLRObject + +/** Required. Data store with which this promotion is attached to. */ +@property(nonatomic, copy, nullable) NSString *dataStore; + +/** Required. Promotion attached to this action. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion *searchLinkPromotion; + @end /** - * The layout parsing configurations for documents. + * Redirects a shopper to the provided URI. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlRedirectAction : GTLRObject /** - * Optional. If true, the processed document will be made available for the - * GetProcessedDocument API. - * - * Uses NSNumber of boolValue. + * Required. The URI to which the shopper will be redirected. Required. URI + * must have length equal or less than 2000 characters. Otherwise an INVALID + * ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSNumber *enableGetProcessedDocument; +@property(nonatomic, copy, nullable) NSString *redirectUri; + +@end + /** - * Optional. If true, the LLM based annotation is added to the image during - * parsing. - * - * Uses NSNumber of boolValue. + * Creates a set of terms that will act as synonyms of one another. Example: + * "happy" will also be considered as "glad", "glad" will also be considered as + * "happy". */ -@property(nonatomic, strong, nullable) NSNumber *enableImageAnnotation; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaControlSynonymsAction : GTLRObject /** - * Optional. If true, the LLM based annotation is added to the table during - * parsing. - * - * Uses NSNumber of boolValue. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at + * least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSNumber *enableTableAnnotation; - -/** Optional. List of HTML classes to exclude from the parsed content. */ -@property(nonatomic, strong, nullable) NSArray *excludeHtmlClasses; +@property(nonatomic, strong, nullable) NSArray *synonyms; -/** Optional. List of HTML elements to exclude from the parsed content. */ -@property(nonatomic, strong, nullable) NSArray *excludeHtmlElements; +@end -/** Optional. List of HTML ids to exclude from the parsed content. */ -@property(nonatomic, strong, nullable) NSArray *excludeHtmlIds; /** - * Optional. Contains the required structure types to extract from the - * document. Supported values: * `shareholder-structure` + * The historical crawl rate timeseries data, used for monitoring. */ -@property(nonatomic, strong, nullable) NSArray *structuredContentTypes; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries : GTLRObject + +/** The QPS of the crawl rate. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries *qpsTimeSeries; @end /** - * The OCR parsing configurations for documents. + * Metadata related to the progress of the DataStoreService.CreateDataStore + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata : GTLRObject -/** - * [DEPRECATED] This field is deprecated. To use the additional enhanced - * document elements processing, please switch to `layout_parsing_config`. - */ -@property(nonatomic, strong, nullable) NSArray *enhancedDocumentElements GTLR_DEPRECATED; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * If true, will use native text instead of OCR text on pages containing native - * text. - * - * Uses NSNumber of boolValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *useNativeText; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the EngineService.CreateEngine + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -11321,1107 +11757,1016 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch - * method. + * Metadata for EvaluationService.CreateEvaluation method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata : GTLRObject @end /** - * Metadata that describes the training and serving parameters of an Engine. + * Metadata for Create Schema LRO. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata : GTLRObject -/** - * Optional. Immutable. This the application type which this engine resource - * represents. NOTE: this is a new concept independ of existing industry - * vertical or solution type. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeIntranet - * App type for intranet search and Agentspace. (Value: - * "APP_TYPE_INTRANET") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeUnspecified - * All non specified apps. (Value: "APP_TYPE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *appType; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Configurations for the Chat Engine. Only applicable if solution_type is - * SOLUTION_TYPE_CHAT. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig *chatEngineConfig; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Output only. Additional information of the Chat Engine. Only applicable if - * solution_type is SOLUTION_TYPE_CHAT. + * Metadata related to the progress of the + * SiteSearchEngineService.CreateSitemap operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata *chatEngineMetadata; - -/** Common config spec that specifies the metadata of the engine. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineCommonConfig *commonConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateSitemapMetadata : GTLRObject -/** Output only. Timestamp the Recommendation Engine was created at. */ +/** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. The data stores associated with this engine. For - * SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they - * can only associate with at most one data store. If solution_type is - * SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be - * associated here. Note that when used in CreateEngineRequest, one DataStore - * id must be provided as the system will use it for necessary initializations. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSArray *dataStoreIds; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Optional. Whether to disable analytics for searches performed on this - * engine. - * - * Uses NSNumber of boolValue. + * Metadata related to the progress of the + * SiteSearchEngineService.CreateTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) NSNumber *disableAnalytics; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Required. The display name of the engine. Should be human readable. UTF-8 - * encoded string with limit of 1024 characters. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Optional. Feature config for the engine to opt in or opt out of features. - * Supported keys: * `*`: all features, if it's present, all other feature - * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * - * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * - * `people-search-org-chart` * `bi-directional-audio` * `feedback` * - * `session-sharing` * `personalization-memory` - Enables personalization based - * on user preferences. + * Defines custom fine tuning spec. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_Features *features; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec : GTLRObject /** - * Optional. The industry vertical that the engine registers. The restriction - * of the Engine industry vertical is based on DataStore: Vertical on Engine - * has to match vertical of the DataStore linked to the engine. + * Whether or not to enable and include custom fine tuned search adaptor model. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_Generic - * The generic vertical for documents that are not specific to any - * industry vertical. (Value: "GENERIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_HealthcareFhir - * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_IndustryVerticalUnspecified - * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_Media - * The media industry vertical. (Value: "MEDIA") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *industryVertical; +@property(nonatomic, strong, nullable) NSNumber *enableSearchAdaptor; -/** - * Configurations for the Media Engine. Only applicable on the data stores with - * solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA - * vertical. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig *mediaRecommendationEngineConfig; +@end -/** - * Immutable. Identifier. The fully qualified resource name of the engine. This - * field must be a UTF-8 encoded string with a length limit of 1024 characters. - * Format: - * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - * engine should be 1-63 characters, and valid characters are /a-z0-9* /. - * Otherwise, an INVALID_ARGUMENT error is returned. - */ -@property(nonatomic, copy, nullable) NSString *name; /** - * Output only. Additional information of a recommendation engine. Only - * applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. + * Manages the connection to external data sources for all data stores grouped + * under a Collection. It's a singleton resource of Collection. The + * initialization is only supported through + * DataConnectorService.SetUpDataConnector method, which will create a new + * Collection and initialize its DataConnector. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata *recommendationMetadata; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector : GTLRObject /** - * Configurations for the Search Engine. Only applicable if solution_type is - * SOLUTION_TYPE_SEARCH. + * Optional. Whether the connector will be created with an ACL config. + * Currently this field only affects Cloud Storage and BigQuery connectors. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig *searchEngineConfig; +@property(nonatomic, strong, nullable) NSNumber *aclEnabled; -/** Additional config specs for a `similar-items` engine. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig *similarDocumentsConfig; +/** Optional. Action configurations to make the connector support actions. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaActionConfig *actionConfig; /** - * Required. The solutions of the engine. + * Output only. State of the action connector. This reflects whether the action + * connector is initializing, active or has encountered errors. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeChat - * Used for use cases related to the Generative AI agent. (Value: - * "SOLUTION_TYPE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeGenerativeChat - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled - * with `SOLUTION_TYPE_CHAT` solution. (Value: - * "SOLUTION_TYPE_GENERATIVE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeRecommendation - * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeSearch - * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeUnspecified - * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Active + * The connector is successfully set up and awaiting next sync run. + * (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Creating + * The connector is being set up. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Failed + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can + * be deleted by [CollectionService.DeleteCollection] API. (Value: + * "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_InitializationFailed + * Connector initialization failed. Potential causes include runtime + * errors or issues in the asynchronous pipeline, preventing the request + * from reaching downstream services (except for some connector types). + * (Value: "INITIALIZATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Running + * The connector is actively syncing records from the data source. + * (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Updating + * Connector is in the process of an update. (Value: "UPDATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ActionState_Warning + * The connector has completed a sync run, but encountered non-fatal + * errors. (Value: "WARNING") */ -@property(nonatomic, copy, nullable) NSString *solutionType; - -/** Output only. Timestamp the Recommendation Engine was last updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, copy, nullable) NSString *actionState; +/** Optional. The connector level alert config. */ +@property(nonatomic, strong, nullable) NSArray *alertPolicyConfigs; /** - * Optional. Feature config for the engine to opt in or opt out of features. - * Supported keys: * `*`: all features, if it's present, all other feature - * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * - * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * - * `people-search-org-chart` * `bi-directional-audio` * `feedback` * - * `session-sharing` * `personalization-memory` - Enables personalization based - * on user preferences. + * Optional. Indicates whether the connector is disabled for auto run. It can + * be used to pause periodical and real time sync. Update: with the + * introduction of incremental_sync_disabled, auto_run_disabled is used to + * pause/disable only full syncs * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_Features : GTLRObject -@end +@property(nonatomic, strong, nullable) NSNumber *autoRunDisabled; +/** Optional. The configuration for establishing a BAP connection. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaBAPConfig *bapConfig; /** - * Configurations for a Chat Engine. + * Output only. User actions that must be completed before the connector can + * start syncing data. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig : GTLRObject +@property(nonatomic, strong, nullable) NSArray *blockingReasons; /** - * The configurationt generate the Dialogflow agent that is associated to this - * Engine. Note that these configurations are one-time consumed by and passed - * to Dialogflow service. It means they cannot be retrieved using - * EngineService.GetEngine or EngineService.ListEngines API after engine - * creation. + * Optional. The modes enabled for this connector. Default state is + * CONNECTOR_MODE_UNSPECIFIED. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig *agentCreationConfig; +@property(nonatomic, strong, nullable) NSArray *connectorModes; /** - * Optional. If the flag set to true, we allow the agent and engine are in - * different locations, otherwise the agent and engine are required to be in - * the same location. The flag is set to false by default. Note that the - * `allow_cross_region` are one-time consumed by and passed to - * EngineService.CreateEngine. It means they cannot be retrieved using - * EngineService.GetEngine or EngineService.ListEngines API after engine - * creation. + * Output only. The type of connector. Each source can only map to one type. + * For example, salesforce, confluence and jira have THIRD_PARTY connector + * type. It is not mutable once set by system. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_BigQuery + * Big query connector. (Value: "BIG_QUERY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ConnectorTypeUnspecified + * Default value. (Value: "CONNECTOR_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_Gcnv + * Google Cloud NetApp Volumes connector. (Value: "GCNV") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GcpFhir + * Data connector connects between FHIR store and VAIS datastore. (Value: + * "GCP_FHIR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_Gcs + * Google Cloud Storage connector. (Value: "GCS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GoogleCalendar + * Google Calendar connector. (Value: "GOOGLE_CALENDAR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GoogleDrive + * Google Drive connector. (Value: "GOOGLE_DRIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_GoogleMail + * Gmail connector. (Value: "GOOGLE_MAIL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_NativeCloudIdentity + * Native Cloud Identity connector for people search powered by People + * API. (Value: "NATIVE_CLOUD_IDENTITY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ThirdParty + * Third party connector to connector to third party application. (Value: + * "THIRD_PARTY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ThirdPartyEua + * Connector utilized for End User Authentication features. (Value: + * "THIRD_PARTY_EUA") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_ConnectorType_ThirdPartyFederated + * Federated connector, it is a third party connector that doesn't + * ingestion data, and search is powered by third party application's + * API. (Value: "THIRD_PARTY_FEDERATED") */ -@property(nonatomic, strong, nullable) NSNumber *allowCrossRegion; +@property(nonatomic, copy, nullable) NSString *connectorType; /** - * The resource name of an exist Dialogflow agent to link to this Chat Engine. - * Customers can either provide `agent_creation_config` to create agent or - * provide an agent name that links the agent with the Chat engine. Format: - * `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are - * one-time consumed by and passed to Dialogflow service. It means they cannot - * be retrieved using EngineService.GetEngine or EngineService.ListEngines API - * after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual - * agent association after Engine is created. + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *dialogflowAgentToLink; - -@end +@property(nonatomic, strong, nullable) NSNumber *createEuaSaas; +/** Output only. Timestamp the DataConnector was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Configurations for generating a Dialogflow agent. Note that these - * configurations are one-time consumed by and passed to Dialogflow service. It - * means they cannot be retrieved using EngineService.GetEngine or - * EngineService.ListEngines API after engine creation. + * Required. The name of the data source. Supported values: `salesforce`, + * `jira`, `confluence`, `bigquery`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *dataSource; /** - * Name of the company, organization or other entity that the agent represents. - * Used for knowledge connector LLM prompt and for knowledge search. + * Optional. Any target destinations used to connect to third-party services. */ -@property(nonatomic, copy, nullable) NSString *business; +@property(nonatomic, strong, nullable) NSArray *destinationConfigs; /** - * Required. The default language of the agent as a language tag. See [Language - * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a - * list of the currently supported language codes. + * Optional. Any params and credentials used specifically for EUA connectors. */ -@property(nonatomic, copy, nullable) NSString *defaultLanguageCode; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig *endUserConfig; + +/** List of entities from the connected data source to ingest. */ +@property(nonatomic, strong, nullable) NSArray *entities; /** - * Agent location for Agent creation, supported values: global/us/eu. If not - * provided, us Engine will create Agent using us-central-1 by default; eu - * Engine will create Agent using eu-west-1 by default. + * Output only. The errors from initialization or from the latest connector + * run. */ -@property(nonatomic, copy, nullable) NSString *location; +@property(nonatomic, strong, nullable) NSArray *errors; /** - * Required. The time zone of the agent from the [time zone - * database](https://www.iana.org/time-zones), e.g., America/New_York, - * Europe/Paris. + * Optional. Any params and credentials used specifically for hybrid connectors + * supporting FEDERATED mode. This field should only be set if the connector is + * a hybrid connector and we want to enable FEDERATED mode. */ -@property(nonatomic, copy, nullable) NSString *timeZone; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig *federatedConfig; /** - * Additional information of a Chat Engine. Fields in this message are output - * only. + * Optional. If the connector is a hybrid connector, determines whether + * ingestion is enabled and appropriate resources are provisioned during + * connector creation. If the connector is not a hybrid connector, this field + * is ignored. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *hybridIngestionDisabled; /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. - * Format: `projects//locations//agents/`. + * The refresh interval to sync the Access Control List information for the + * documents ingested by this connector. If not set, the access control list + * will be refreshed at the default interval of 30 minutes. The identity + * refresh interval can be at least 30 minutes and at most 7 days. */ -@property(nonatomic, copy, nullable) NSString *dialogflowAgent; - -@end - +@property(nonatomic, strong, nullable) GTLRDuration *identityRefreshInterval GTLR_DEPRECATED; /** - * Common configurations for an Engine. + * The configuration for the identity data synchronization runs. This contains + * the refresh interval to sync the Access Control List information for the + * documents ingested by this connector. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineCommonConfig : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig *identityScheduleConfig; /** - * The name of the company, business or entity that is associated with the - * engine. Setting this may help improve LLM related features. + * Optional. The refresh interval specifically for incremental data syncs. If + * unset, incremental syncs will use the default from env, set to 3hrs. The + * minimum is 30 minutes and maximum is 7 days. Applicable to only 3P + * connectors. When the refresh interval is set to the same value as the + * incremental refresh interval, incremental sync will be disabled. */ -@property(nonatomic, copy, nullable) NSString *companyName; - -@end - +@property(nonatomic, strong, nullable) GTLRDuration *incrementalRefreshInterval; /** - * Additional config specs for a Media Recommendation engine. + * Optional. Indicates whether incremental syncs are paused for this connector. + * This is independent of auto_run_disabled. Applicable to only 3P connectors. + * When the refresh interval is set to the same value as the incremental + * refresh interval, incremental sync will be disabled, i.e. set to true. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *incrementalSyncDisabled; -/** Optional. Additional engine features config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig *engineFeaturesConfig; +/** Required data connector parameters in json string format. */ +@property(nonatomic, copy, nullable) NSString *jsonParams; /** - * The optimization objective. e.g., `cvr`. This field together with - * optimization_objective describe engine metadata to use to control engine - * training and serving. Currently supported values: `ctr`, `cvr`. If not - * specified, we choose default based on engine type. Default depends on type - * of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => - * `ctr` + * Input only. The KMS key to be used to protect the DataStores managed by this + * connector. Must be set for requests that need to comply with CMEK Org Policy + * protections. If this field is set and processed successfully, the DataStores + * created by this connector will be protected by the KMS key. */ -@property(nonatomic, copy, nullable) NSString *optimizationObjective; +@property(nonatomic, copy, nullable) NSString *kmsKeyName; /** - * Name and value of the custom threshold for cvr optimization_objective. For - * target_field `watch-time`, target_field_value must be an integer value - * indicating the media progress time in seconds between (0, 86400] (excludes - * 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the - * target_field_value must be a valid float value between (0, 1.0] (excludes 0, - * includes 1.0) (e.g., 0.5). + * Output only. For periodic connectors only, the last time a data sync was + * completed. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig *optimizationObjectiveConfig; +@property(nonatomic, strong, nullable) GTLRDateTime *lastSyncTime; /** - * The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). - * Since part of the cost of running the service is frequency of training - - * this can be used to determine when to train engine in order to control cost. - * If not specified: the default value for `CreateEngine` method is `TRAINING`. - * The default value for `UpdateEngine` method is to keep the state the same as - * before. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig_TrainingState_Paused - * The engine training is paused. (Value: "PAUSED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig_TrainingState_Training - * The engine is training. (Value: "TRAINING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig_TrainingState_TrainingStateUnspecified - * Unspecified training state. (Value: "TRAINING_STATE_UNSPECIFIED") + * Output only. The most recent timestamp when this DataConnector was paused, + * affecting all functionalities such as data synchronization. Pausing a + * connector has the following effects: - All functionalities, including data + * synchronization, are halted. - Any ongoing data synchronization job will be + * canceled. - No future data synchronization runs will be scheduled nor can be + * triggered. */ -@property(nonatomic, copy, nullable) NSString *trainingState; +@property(nonatomic, strong, nullable) GTLRDateTime *latestPauseTime; /** - * Required. The type of engine. e.g., `recommended-for-you`. This field - * together with optimization_objective describe engine metadata to use to - * control engine training and serving. Currently supported values: - * `recommended-for-you`, `others-you-may-like`, `more-like-this`, - * `most-popular-items`. + * Output only. The full resource name of the Data Connector. Format: + * `projects/ * /locations/ * /collections/ * /dataConnector`. */ -@property(nonatomic, copy, nullable) NSString *type; - -@end - +@property(nonatomic, copy, nullable) NSString *name; /** - * More feature configs of the selected engine type. + * Defines the scheduled time for the next data synchronization. This field + * requires hour , minute, and time_zone from the [IANA Time Zone + * Database](https://www.iana.org/time-zones). This is utilized when the data + * connector has a refresh interval greater than 1 day. When the hours or + * minutes are not specified, we will assume a sync time of 0:00. The user must + * provide a time zone to avoid ambiguity. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig : GTLRObject - -/** Most popular engine feature config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig *mostPopularConfig; - -/** Recommended for you engine feature config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig *recommendedForYouConfig; - -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDateTime *nextSyncTime; +/** Required data connector parameters in structured json format. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_Params *params; /** - * Feature configurations that are required for creating a Most Popular engine. + * Output only. The tenant project ID associated with private connectivity + * connectors. This project must be allowlisted by in order for the connector + * to function. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *privateConnectivityProjectId; /** - * The time window of which the engine is queried at training and prediction - * time. Positive integers only. The value translates to the last X days of - * events. Currently required for the `most-popular-items` engine. + * Output only. real-time sync state * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Active + * The connector is successfully set up and awaiting next sync run. + * (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Creating + * The connector is being set up. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Failed + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can + * be deleted by [CollectionService.DeleteCollection] API. (Value: + * "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_InitializationFailed + * Connector initialization failed. Potential causes include runtime + * errors or issues in the asynchronous pipeline, preventing the request + * from reaching downstream services (except for some connector types). + * (Value: "INITIALIZATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Running + * The connector is actively syncing records from the data source. + * (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Updating + * Connector is in the process of an update. (Value: "UPDATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_RealtimeState_Warning + * The connector has completed a sync run, but encountered non-fatal + * errors. (Value: "WARNING") */ -@property(nonatomic, strong, nullable) NSNumber *timeWindowDays; - -@end +@property(nonatomic, copy, nullable) NSString *realtimeState; +/** Optional. The configuration for realtime sync. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig *realtimeSyncConfig; /** - * Custom threshold for `cvr` optimization_objective. + * Required. The refresh interval for data sync. If duration is set to 0, the + * data will be synced in real time. The streaming feature is not supported + * yet. The minimum is 30 minutes and maximum is 7 days. When the refresh + * interval is set to the same value as the incremental refresh interval, + * incremental sync will be disabled. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig : GTLRObject +@property(nonatomic, strong, nullable) GTLRDuration *refreshInterval; /** - * Required. The name of the field to target. Currently supported values: - * `watch-percentage`, `watch-time`. + * Optional. Specifies keys to be removed from the 'params' field. This is only + * active when 'params' is included in the 'update_mask' in an + * UpdateDataConnectorRequest. Deletion takes precedence if a key is both in + * 'remove_param_keys' and present in the 'params' field of the request. */ -@property(nonatomic, copy, nullable) NSString *targetField; +@property(nonatomic, strong, nullable) NSArray *removeParamKeys; /** - * Required. The threshold to be applied to the target (e.g., 0.5). + * Output only. State of the connector. * - * Uses NSNumber of floatValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Active + * The connector is successfully set up and awaiting next sync run. + * (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Creating + * The connector is being set up. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Failed + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can + * be deleted by [CollectionService.DeleteCollection] API. (Value: + * "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_InitializationFailed + * Connector initialization failed. Potential causes include runtime + * errors or issues in the asynchronous pipeline, preventing the request + * from reaching downstream services (except for some connector types). + * (Value: "INITIALIZATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Running + * The connector is actively syncing records from the data source. + * (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Updating + * Connector is in the process of an update. (Value: "UPDATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_State_Warning + * The connector has completed a sync run, but encountered non-fatal + * errors. (Value: "WARNING") */ -@property(nonatomic, strong, nullable) NSNumber *targetFieldValueFloat; - -@end +@property(nonatomic, copy, nullable) NSString *state; +/** Output only. The static IP addresses used by this connector. */ +@property(nonatomic, strong, nullable) NSArray *staticIpAddresses; /** - * Additional feature configurations for creating a `recommended-for-you` - * engine. + * Optional. Whether customer has enabled static IP addresses for this + * connector. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *staticIpEnabled; /** - * The type of event with which the engine is queried at prediction time. If - * set to `generic`, only `view-item`, `media-play`,and `media-complete` will - * be used as `context-event` in engine training. If set to `view-home-page`, - * `view-home-page` will also be used as `context-events` in addition to - * `view-item`, `media-play`, and `media-complete`. Currently supported for the - * `recommended-for-you` engine. Currently supported values: `view-home-page`, - * `generic`. + * The data synchronization mode supported by the data connector. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_SyncMode_Periodic + * The connector will sync data periodically based on the + * refresh_interval. Use it with auto_run_disabled to pause the periodic + * sync, or indicate a one-time sync. (Value: "PERIODIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_SyncMode_Streaming + * The data will be synced in real time. (Value: "STREAMING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_SyncMode_Unspecified + * Connector that doesn't ingest data will have this value (Value: + * "UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *contextEventType; +@property(nonatomic, copy, nullable) NSString *syncMode; -@end +/** Output only. Timestamp the DataConnector was last updated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@end -/** - * Additional information of a recommendation engine. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata : GTLRObject /** - * Output only. The state of data requirements for this engine: `DATA_OK` and - * `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. - * Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: - * engines were trained successfully before, but cannot be refreshed because - * the underlying engine no longer has sufficient data for training. + * Required data connector parameters in structured json format. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_DataState_DataError - * The engine does not have sufficient training data. Error messages can - * be queried via Stackdriver. (Value: "DATA_ERROR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_DataState_DataOk - * The engine has sufficient training data. (Value: "DATA_OK") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_DataState_DataStateUnspecified - * Unspecified default value, should never be explicitly set. (Value: - * "DATA_STATE_UNSPECIFIED") + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *dataState; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnector_Params : GTLRObject +@end -/** - * Output only. The timestamp when the latest successful training finished. - * Only applicable on Media Recommendation engines. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *lastTrainTime; /** - * Output only. The timestamp when the latest successful tune finished. Only - * applicable on Media Recommendation engines. + * Any params and credentials used specifically for EUA connectors. */ -@property(nonatomic, strong, nullable) GTLRDateTime *lastTuneTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig : GTLRObject -/** - * Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_Active - * The engine is serving and can be queried. (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_Inactive - * The engine is not serving. (Value: "INACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_ServingStateUnspecified - * Unspecified serving state. (Value: "SERVING_STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_Tuned - * The engine is trained on tuned hyperparameters and can be queried. - * (Value: "TUNED") - */ -@property(nonatomic, copy, nullable) NSString *servingState; +/** Optional. Any additional parameters needed for EUA. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AdditionalParams *additionalParams; + +/** Optional. Any authentication parameters specific to EUA connectors. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AuthParams *authParams; /** - * Output only. The latest tune operation id associated with the engine. Only - * applicable on Media Recommendation engines. If present, this operation id - * can be used to determine if there is an ongoing tune for this engine. To - * check the operation status, send the GetOperation request with this - * operation id in the engine resource format. If no tuning has happened for - * this engine, the string is empty. + * Optional. Any authentication parameters specific to EUA connectors in json + * string format. */ -@property(nonatomic, copy, nullable) NSString *tuningOperation; +@property(nonatomic, copy, nullable) NSString *jsonAuthParams; + +/** Optional. The tenant project the connector is connected to. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTenant *tenant; @end /** - * Configurations for a Search Engine. + * Optional. Any additional parameters needed for EUA. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AdditionalParams : GTLRObject +@end -/** The add-on that this search engine enables. */ -@property(nonatomic, strong, nullable) NSArray *searchAddOns; /** - * The search feature tier of this engine. Different tiers might have different - * pricing. To learn more, check the pricing documentation. Defaults to - * SearchTier.SEARCH_TIER_STANDARD if not specified. + * Optional. Any authentication parameters specific to EUA connectors. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig_SearchTier_SearchTierEnterprise - * Enterprise tier. (Value: "SEARCH_TIER_ENTERPRISE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig_SearchTier_SearchTierStandard - * Standard tier. (Value: "SEARCH_TIER_STANDARD") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig_SearchTier_SearchTierUnspecified - * Default value when the enum is unspecified. This is invalid to use. - * (Value: "SEARCH_TIER_UNSPECIFIED") + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *searchTier; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig_AuthParams : GTLRObject @end /** - * Additional config specs for a `similar-items` engine. + * Any params and credentials used specifically for hybrid connectors + * supporting FEDERATED mode. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig : GTLRObject -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig : GTLRObject +/** Optional. Any additional parameters needed for FEDERATED. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AdditionalParams *additionalParams; /** - * Metadata related to the progress of the EstimateDataSize operation. This is - * returned by the google.longrunning.Operation.metadata field. + * Optional. Any authentication parameters specific to FEDERATED connectors. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AuthParams *authParams; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Optional. Any authentication parameters specific to FEDERATED connectors in + * json string format. + */ +@property(nonatomic, copy, nullable) NSString *jsonAuthParams; @end /** - * Response of the EstimateDataSize request. If the long running operation was - * successful, then this message is returned by the - * google.longrunning.Operations.response field if the operation was - * successful. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse : GTLRObject - -/** - * Data size in terms of bytes. + * Optional. Any additional parameters needed for FEDERATED. * - * Uses NSNumber of longLongValue. + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *dataSizeBytes; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AdditionalParams : GTLRObject +@end + /** - * Total number of documents. + * Optional. Any authentication parameters specific to FEDERATED connectors. * - * Uses NSNumber of longLongValue. + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *documentCount; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig_AuthParams : GTLRObject @end /** - * An evaluation is a single execution (or run) of an evaluation process. It - * encapsulates the state of the evaluation and the resulting data. + * The configuration for realtime sync to store additional params for realtime + * sync. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig : GTLRObject -/** Output only. Timestamp the Evaluation was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. The ID of the Secret Manager secret used for webhook secret. */ +@property(nonatomic, copy, nullable) NSString *realtimeSyncSecret; -/** Output only. Timestamp the Evaluation was completed at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** Optional. Streaming error details. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError *streamingError; /** - * Output only. The error that occurred during evaluation. Only populated when - * the evaluation's state is FAILED. + * Optional. Webhook url for the connector to specify additional params for + * realtime sync. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +@property(nonatomic, copy, nullable) NSString *webhookUri; -/** - * Output only. A sample of errors encountered while processing the request. - */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +@end -/** Required. The specification of the evaluation. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec *evaluationSpec; /** - * Identifier. The full resource name of the Evaluation, in the format of - * `projects/{project}/locations/{location}/evaluations/{evaluation}`. This - * field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Streaming error details. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError : GTLRObject -/** - * Output only. The metrics produced by the evaluation, averaged across all - * SampleQuerys in the SampleQuerySet. Only populated when the evaluation's - * state is SUCCEEDED. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetrics *qualityMetrics; +/** Optional. Error details. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; /** - * Output only. The state of the evaluation. + * Optional. Streaming error. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Failed - * The evaluation failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Pending - * The service is preparing to run the evaluation. (Value: "PENDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Running - * The evaluation is in progress. (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_StateUnspecified - * The evaluation is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Succeeded - * The evaluation completed successfully. (Value: "SUCCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_IngressEndpointRequired + * Ingress endpoint is required when setting up realtime sync in private + * connectivity. (Value: "INGRESS_ENDPOINT_REQUIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingErrorReasonUnspecified + * Streaming error reason unspecified. (Value: + * "STREAMING_ERROR_REASON_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSetupError + * Some error occurred while setting up resources for realtime sync. + * (Value: "STREAMING_SETUP_ERROR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError + * Some error was encountered while running realtime sync for the + * connector. (Value: "STREAMING_SYNC_ERROR") */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, copy, nullable) NSString *streamingErrorReason; @end /** - * Describes the specification of the evaluation. + * Represents an entity in the data source. For example, the `Account` object + * in Salesforce. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec : GTLRObject - -/** Optional. The specification of the query set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec *querySetSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity : GTLRObject /** - * Required. The search request that is used to perform the evaluation. Only - * the following fields within SearchRequest are supported; if any other fields - * are provided, an UNSUPPORTED error will be returned: * - * SearchRequest.serving_config * SearchRequest.branch * - * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * - * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * - * SearchRequest.user_pseudo_id + * Output only. The full resource name of the associated data store for the + * source entity. Format: `projects/ * /locations/ * /collections/ * + * /dataStores/ *`. When the connector is initialized by the + * DataConnectorService.SetUpDataConnector method, a DataStore is automatically + * created for each source entity. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest *searchRequest; +@property(nonatomic, copy, nullable) NSString *dataStore; -@end +/** + * The name of the entity. Supported values by data source: * Salesforce: + * `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` + * * Jira: `Issue` * Confluence: `Content`, `Space` + * + * Remapped to 'entityNameProperty' to avoid NSObject's 'entityName'. + */ +@property(nonatomic, copy, nullable) NSString *entityNameProperty; +/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig *healthcareFhirConfig; /** - * Describes the specification of the query set. + * The parameters for the entity to facilitate data ingestion in json string + * format. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *jsonParams; /** - * Optional. The full resource name of the SampleQuerySet used for the - * evaluation, in the format of - * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. + * Attributes for indexing. Key: Field name. Value: The key property to map a + * field to, such as `title`, and `description`. Supported key properties: * + * `title`: The title for data record. This would be displayed on search + * results. * `description`: The description for data record. This would be + * displayed on search results. */ -@property(nonatomic, copy, nullable) NSString *sampleQuerySet; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_KeyPropertyMappings *keyPropertyMappings; /** - * Metadata related to the progress of the Export operation. This is returned - * by the google.longrunning.Operation.metadata field. + * The parameters for the entity to facilitate data ingestion in structured + * json format. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_Params *params; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The start schema to use for the DataStore created from this + * SourceEntity. If unset, a default vertical specialized schema will be used. + * This field is only used by SetUpDataConnector API, and will be ignored if + * used in other APIs. This field will be omitted from all API responses + * including GetDataConnector API. To retrieve a schema of a DataStore, use + * SchemaService.GetSchema API instead. The provided schema will be validated + * against certain rules on schema. Learn more from [this + * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema *startingSchema; @end /** - * Response of the ExportMetricsRequest. If the long running operation was - * successful, then this message is returned by the - * google.longrunning.Operations.response field. + * Attributes for indexing. Key: Field name. Value: The key property to map a + * field to, such as `title`, and `description`. Supported key properties: * + * `title`: The title for data record. This would be displayed on search + * results. * `description`: The description for data record. This would be + * displayed on search results. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaExportMetricsResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_KeyPropertyMappings : GTLRObject @end /** - * Configurations for fields of a schema. For example, configuring a field is - * indexable, or searchable. + * The parameters for the entity to facilitate data ingestion in structured + * json format. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity_Params : GTLRObject +@end + /** - * If this field is set, only the corresponding source will be indexed for this - * field. Otherwise, the values from different sources are merged. Assuming a - * page with `` in meta tag, and `` in page map: if this enum is set to - * METATAGS, we will only index ``; if this enum is not set, we will merge them - * and index ``. + * DataStore captures global settings and configs at the DataStore level. */ -@property(nonatomic, strong, nullable) NSArray *advancedSiteSearchDataSources; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore : GTLRObject /** - * If completable_option is COMPLETABLE_ENABLED, field values are directly used - * and returned as suggestions for Autocomplete in - * CompletionService.CompleteQuery. If completable_option is unset, the server - * behavior defaults to COMPLETABLE_DISABLED for fields that support setting - * completable options, which are just `string` fields. For those fields that - * do not support setting completable options, the server will skip completable - * option setting, and setting completable_option for those fields will throw - * `INVALID_ARGUMENT` error. + * Immutable. Whether data in the DataStore has ACL information. If set to + * `true`, the source data must have ACL. ACL will be ingested when data is + * ingested by DocumentService.ImportDocuments methods. When ACL is enabled for + * the DataStore, Document can't be accessed by calling + * DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL + * is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` + * content config. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_CompletableOption_CompletableDisabled - * Completable option disabled for a schema field. (Value: - * "COMPLETABLE_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_CompletableOption_CompletableEnabled - * Completable option enabled for a schema field. (Value: - * "COMPLETABLE_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_CompletableOption_CompletableOptionUnspecified - * Value used when unset. (Value: "COMPLETABLE_OPTION_UNSPECIFIED") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *completableOption; +@property(nonatomic, strong, nullable) NSNumber *aclEnabled; + +/** Optional. Configuration for advanced site search. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig *advancedSiteSearchConfig; + +/** Output only. Data size estimation for billing. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation *billingEstimation; + +/** Output only. CMEK-related information for the DataStore. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCmekConfig *cmekConfig; /** - * If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are - * available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if - * FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an - * `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is - * unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields - * that support setting dynamic facetable options. For those fields that do not - * support setting dynamic facetable options, such as `object` and `boolean`, - * the server will skip dynamic facetable option setting, and setting - * dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` - * error. + * Optional. Configuration for configurable billing approach. See * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_DynamicFacetableOption_DynamicFacetableDisabled - * Dynamic facetable option disabled for a schema field. (Value: - * "DYNAMIC_FACETABLE_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_DynamicFacetableOption_DynamicFacetableEnabled - * Dynamic facetable option enabled for a schema field. (Value: - * "DYNAMIC_FACETABLE_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_DynamicFacetableOption_DynamicFacetableOptionUnspecified - * Value used when unset. (Value: "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *dynamicFacetableOption; - -/** - * Required. Field path of the schema field. For example: `title`, - * `description`, `release_info.release_year`. + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified + * Default value. For Spark and non-Spark non-configurable billing + * approach. (Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding + * Use the consumption pay-as-you-go billing for embedding storage + * add-on. (Value: "CONFIGURABLE_CONSUMPTION_EMBEDDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore + * Use the subscription base + overage billing for indexing core for non + * embedding storage. (Value: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE") */ -@property(nonatomic, copy, nullable) NSString *fieldPath; +@property(nonatomic, copy, nullable) NSString *configurableBillingApproach; /** - * Output only. Raw type of the field. + * Immutable. The content config of the data store. If this field is unset, the + * server behavior defaults to ContentConfig.NO_CONTENT. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Boolean - * Field value type is Boolean. (Value: "BOOLEAN") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Datetime - * Field value type is Datetime. Datetime can be expressed as either: * a - * number representing milliseconds-since-the-epoch * a string - * representing milliseconds-since-the-epoch. e.g. `"1420070400001"` * a - * string representing the [ISO - * 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. - * e.g. `"2015-01-01"` or `"2015-01-01T12:10:30Z"` (Value: "DATETIME") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_FieldTypeUnspecified - * Field type is unspecified. (Value: "FIELD_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Geolocation - * Field value type is Geolocation. Geolocation is expressed as an object - * with the following keys: * `id`: a string representing the location id - * * `longitude`: a number representing the longitude coordinate of the - * location * `latitude`: a number repesenting the latitude coordinate of - * the location * `address`: a string representing the full address of - * the location `latitude` and `longitude` must always be provided - * together. At least one of a) `address` or b) `latitude`-`longitude` - * pair must be provided. (Value: "GEOLOCATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Integer - * Field value type is Integer. (Value: "INTEGER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Number - * Field value type is Number. (Value: "NUMBER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Object - * Field value type is Object. (Value: "OBJECT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_String - * Field value type is String. (Value: "STRING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_ContentConfigUnspecified + * Default value. (Value: "CONTENT_CONFIG_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_ContentRequired + * Only contains documents with Document.content. (Value: + * "CONTENT_REQUIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_GoogleWorkspace + * The data store is used for workspace search. Details of workspace data + * store are specified in the WorkspaceConfig. (Value: + * "GOOGLE_WORKSPACE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_NoContent + * Only contains documents without any Document.content. (Value: + * "NO_CONTENT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_ContentConfig_PublicWebsite + * The data store is used for public website search. (Value: + * "PUBLIC_WEBSITE") */ -@property(nonatomic, copy, nullable) NSString *fieldType; +@property(nonatomic, copy, nullable) NSString *contentConfig; + +/** Output only. Timestamp the DataStore was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * If indexable_option is INDEXABLE_ENABLED, field values are indexed so that - * it can be filtered or faceted in SearchService.Search. If indexable_option - * is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that - * support setting indexable options. For those fields that do not support - * setting indexable options, such as `object` and `boolean` and key - * properties, the server will skip indexable_option setting, and setting - * indexable_option for those fields will throw `INVALID_ARGUMENT` error. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_IndexableOption_IndexableDisabled - * Indexable option disabled for a schema field. (Value: - * "INDEXABLE_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_IndexableOption_IndexableEnabled - * Indexable option enabled for a schema field. (Value: - * "INDEXABLE_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_IndexableOption_IndexableOptionUnspecified - * Value used when unset. (Value: "INDEXABLE_OPTION_UNSPECIFIED") + * Output only. The id of the default Schema associated to this data store. */ -@property(nonatomic, copy, nullable) NSString *indexableOption; +@property(nonatomic, copy, nullable) NSString *defaultSchemaId; /** - * Output only. Type of the key property that this field is mapped to. Empty - * string if this is not annotated as mapped to a key property. Example types - * are `title`, `description`. Full list is defined by `keyPropertyMapping` in - * the schema field annotation. If the schema field has a `KeyPropertyMapping` - * annotation, `indexable_option` and `searchable_option` of this field cannot - * be modified. + * Required. The data store display name. This field must be a UTF-8 encoded + * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT + * error is returned. */ -@property(nonatomic, copy, nullable) NSString *keyPropertyType; +@property(nonatomic, copy, nullable) NSString *displayName; + +/** Configuration for Document understanding and enrichment. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig *documentProcessingConfig; + +/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig *healthcareFhirConfig; /** - * Optional. The metatag name found in the HTML page. If user defines this - * field, the value of this metatag name will be used to extract metatag. If - * the user does not define this field, the FieldConfig.field_path will be used - * to extract metatag. + * Immutable. The fully qualified resource name of the associated + * IdentityMappingStore. This field can only be set for acl_enabled DataStores + * with `THIRD_PARTY` or `GSUITE` IdP. Format: + * `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */ -@property(nonatomic, copy, nullable) NSString *metatagName; +@property(nonatomic, copy, nullable) NSString *identityMappingStore; + +/** Output only. Data store level identity provider config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig *idpConfig; /** - * If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable - * by filter expression in RecommendationService.Recommend. If - * FILTERABLE_ENABLED but the field type is numerical, field values are not - * filterable by text queries in RecommendationService.Recommend. Only textual - * fields are supported. If recs_filterable_option is unset, the default - * setting is FILTERABLE_DISABLED for fields that support setting filterable - * options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is - * generated and an empty result is returned. + * Immutable. The industry vertical that the data store registers. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RecsFilterableOption_FilterableDisabled - * Filterable option disabled for a schema field. (Value: - * "FILTERABLE_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RecsFilterableOption_FilterableEnabled - * Filterable option enabled for a schema field. (Value: - * "FILTERABLE_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RecsFilterableOption_FilterableOptionUnspecified - * Value used when unset. (Value: "FILTERABLE_OPTION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_Generic + * The generic vertical for documents that are not specific to any + * industry vertical. (Value: "GENERIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_HealthcareFhir + * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_IndustryVerticalUnspecified + * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStore_IndustryVertical_Media + * The media industry vertical. (Value: "MEDIA") */ -@property(nonatomic, copy, nullable) NSString *recsFilterableOption; +@property(nonatomic, copy, nullable) NSString *industryVertical; /** - * If retrievable_option is RETRIEVABLE_ENABLED, field values are included in - * the search results. If retrievable_option is unset, the server behavior - * defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable - * options. For those fields that do not support setting retrievable options, - * such as `object` and `boolean`, the server will skip retrievable option - * setting, and setting retrievable_option for those fields will throw - * `INVALID_ARGUMENT` error. + * Optional. If set, this DataStore is an Infobot FAQ DataStore. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RetrievableOption_RetrievableDisabled - * Retrievable option disabled for a schema field. (Value: - * "RETRIEVABLE_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RetrievableOption_RetrievableEnabled - * Retrievable option enabled for a schema field. (Value: - * "RETRIEVABLE_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RetrievableOption_RetrievableOptionUnspecified - * Value used when unset. (Value: "RETRIEVABLE_OPTION_UNSPECIFIED") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *retrievableOption; +@property(nonatomic, strong, nullable) NSNumber *isInfobotFaqDataStore; /** - * Field paths for indexing custom attribute from schema.org data. More details - * of schema.org and its defined types can be found at - * [schema.org](https://schema.org). It is only used on advanced site search - * schema. Currently only support full path from root. The full path to a field - * is constructed by concatenating field names, starting from `_root`, with a - * period `.` as the delimiter. Examples: * Publish date of the root: - * _root.datePublished * Publish date of the reviews: - * _root.review.datePublished + * Input only. The KMS key to be used to protect this DataStore at creation + * time. Must be set for requests that need to comply with CMEK Org Policy + * protections. If this field is set and processed successfully, the DataStore + * will be protected by the KMS key, as indicated in the cmek_config field. */ -@property(nonatomic, strong, nullable) NSArray *schemaOrgPaths; +@property(nonatomic, copy, nullable) NSString *kmsKeyName; + +/** Language info for DataStore. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLanguageInfo *languageInfo; /** - * If searchable_option is SEARCHABLE_ENABLED, field values are searchable by - * text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type - * is numerical, field values will not be searchable by text queries in - * SearchService.Search, as there are no text values associated to numerical - * fields. If searchable_option is unset, the server behavior defaults to - * SEARCHABLE_DISABLED for fields that support setting searchable options. Only - * `string` fields that have no key property mapping support setting - * searchable_option. For those fields that do not support setting searchable - * options, the server will skip searchable option setting, and setting - * searchable_option for those fields will throw `INVALID_ARGUMENT` error. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_SearchableOption_SearchableDisabled - * Searchable option disabled for a schema field. (Value: - * "SEARCHABLE_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_SearchableOption_SearchableEnabled - * Searchable option enabled for a schema field. (Value: - * "SEARCHABLE_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_SearchableOption_SearchableOptionUnspecified - * Value used when unset. (Value: "SEARCHABLE_OPTION_UNSPECIFIED") + * Immutable. Identifier. The full resource name of the data store. Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + * This field must be a UTF-8 encoded string with a length limit of 1024 + * characters. */ -@property(nonatomic, copy, nullable) NSString *searchableOption; +@property(nonatomic, copy, nullable) NSString *name; -@end +/** Optional. Configuration for Natural Language Query Understanding. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig *naturalLanguageQueryUnderstandingConfig; +/** Optional. Stores serving config at DataStore level. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore *servingConfigDataStore; /** - * Request for GetSession method. + * The solutions that the data store enrolls. Available solutions for each + * industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and + * `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is + * automatically enrolled. Other solutions cannot be enrolled. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetSessionRequest : GTLRObject +@property(nonatomic, strong, nullable) NSArray *solutionTypes; /** - * Optional. If set to true, the full session including all answer details will - * be returned. - * - * Uses NSNumber of boolValue. + * The start schema to use for this DataStore when provisioning it. If unset, a + * default vertical specialized schema will be used. This field is only used by + * CreateDataStore API, and will be ignored if used in other APIs. This field + * will be omitted from all API responses including CreateDataStore API. To + * retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. + * The provided schema will be validated against certain rules on schema. Learn + * more from [this + * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ -@property(nonatomic, strong, nullable) NSNumber *includeAnswerDetails; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema *startingSchema; /** - * Required. The resource name of the Session to get. Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + * Config to store data store type configuration for workspace data. This must + * be set when DataStore.content_config is set as + * DataStore.ContentConfig.GOOGLE_WORKSPACE. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaWorkspaceConfig *workspaceConfig; @end /** - * Response message for SiteSearchEngineService.GetUriPatternDocumentData - * method. + * Estimation of data size per data store. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation : GTLRObject /** - * Document data keyed by URI pattern. For example: document_data_map = { - * "www.url1.com/ *": { "Categories": ["category1", "category2"] }, - * "www.url2.com/ *": { "Categories": ["category3"] } } + * Data size for structured data in terms of bytes. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap *documentDataMap; - -@end +@property(nonatomic, strong, nullable) NSNumber *structuredDataSize; +/** Last updated timestamp for structured data. */ +@property(nonatomic, strong, nullable) GTLRDateTime *structuredDataUpdateTime; /** - * Document data keyed by URI pattern. For example: document_data_map = { - * "www.url1.com/ *": { "Categories": ["category1", "category2"] }, - * "www.url2.com/ *": { "Categories": ["category3"] } } + * Data size for unstructured data in terms of bytes. * - * @note This class is documented as having more properties of - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap_DocumentDataMap. - * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get - * the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap : GTLRObject -@end +@property(nonatomic, strong, nullable) NSNumber *unstructuredDataSize; +/** Last updated timestamp for unstructured data. */ +@property(nonatomic, strong, nullable) GTLRDateTime *unstructuredDataUpdateTime; /** - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap_DocumentDataMap + * Data size for websites in terms of bytes. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap_DocumentDataMap : GTLRObject -@end +@property(nonatomic, strong, nullable) NSNumber *websiteDataSize; +/** Last updated timestamp for websites. */ +@property(nonatomic, strong, nullable) GTLRDateTime *websiteDataUpdateTime; + +@end -/** - * Config to data store for `HEALTHCARE_FHIR` vertical. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig : GTLRObject /** - * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set - * to `true`, the predefined healthcare fhir schema can be extended for more - * customized searching and filtering. - * - * Uses NSNumber of boolValue. + * Stores information regarding the serving configurations at DataStore level. */ -@property(nonatomic, strong, nullable) NSNumber *enableConfigurableSchema; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore : GTLRObject /** - * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If - * set to `true`, the batch ingestion will be processed in a static indexing - * mode which is slower but more capable of handling larger volume. + * Optional. If set true, the DataStore will not be available for serving + * search requests. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *enableStaticIndexingForBatchIngestion; +@property(nonatomic, strong, nullable) NSNumber *disabledForServing; @end /** - * IdentityMappingEntry LongRunningOperation metadata for - * IdentityMappingStoreService.ImportIdentityMappings and - * IdentityMappingStoreService.PurgeIdentityMappings + * The historical dedicated crawl rate timeseries data, used for monitoring. + * Dedicated crawl is used by Vertex AI to crawl the user's website when + * dedicate crawl is set. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries : GTLRObject -/** - * The number of IdentityMappingEntries that failed to be processed. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +/** Vertex AI's error rate time series of auto-refresh dedicated crawl. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *autoRefreshCrawlErrorRate; /** - * The number of IdentityMappingEntries that were successfully processed. - * - * Uses NSNumber of longLongValue. + * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the + * crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the + * crawl rate is for best effort use cases like refreshing urls periodically. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *autoRefreshCrawlRate; + +/** Vertex AI's error rate time series of user triggered dedicated crawl. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *userTriggeredCrawlErrorRate; /** - * The total number of IdentityMappingEntries that were processed. - * - * Uses NSNumber of longLongValue. + * Vertex AI's dedicated crawl rate time series of user triggered crawl, which + * is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and + * user triggered crawl rate is for deterministic use cases like crawling urls + * or sitemaps specified by users. */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *userTriggeredCrawlRate; @end /** - * The configuration for the identity data synchronization runs. + * Metadata related to the progress of the CmekConfigService.DeleteCmekConfig + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata : GTLRObject -/** - * Optional. The UTC time when the next data sync is expected to start for the - * Data Connector. Customers are only able to specify the hour and minute to - * schedule the data sync. This is utilized when the data connector has a - * refresh interval greater than 1 day. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDateTime *nextSyncTime; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. The refresh interval to sync the Access Control List information - * for the documents ingested by this connector. If not set, the access control - * list will be refreshed at the default interval of 30 minutes. The identity - * refresh interval can be at least 30 minutes and at most 7 days. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) GTLRDuration *refreshInterval; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Identity Provider Config. + * Metadata related to the progress of the CollectionService.UpdateCollection + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata : GTLRObject -/** External Identity provider config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig *externalIdpConfig; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Identity provider type configured. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_Gsuite - * Google 1P provider. (Value: "GSUITE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_IdpTypeUnspecified - * Default value. ACL search not enabled. (Value: "IDP_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_ThirdParty - * Third party provider. (Value: "THIRD_PARTY") - */ -@property(nonatomic, copy, nullable) NSString *idpType; - -@end - - -/** - * Third party IDP Config. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig : GTLRObject - -/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */ -@property(nonatomic, copy, nullable) NSString *workforcePoolName; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Metadata related to the progress of the ImportCompletionSuggestions + * Metadata related to the progress of the DataStoreService.DeleteDataStore * operation. This will be returned by the * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** - * Count of CompletionSuggestions that failed to be imported. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; - -/** - * Count of CompletionSuggestions successfully imported. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *successCount; - /** * Operation last update time. If the operation is done, this is also the * finish time. @@ -12432,50 +12777,50 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the - * long running operation is done, this message is returned by the - * google.longrunning.Operations.response field if the operation is successful. + * Metadata related to the progress of the EngineService.DeleteEngine + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata : GTLRObject -/** The desired location of errors incurred during the Import. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Metadata related to the progress of the ImportDocuments operation. This is - * returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the + * IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will + * be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Count of entries that encountered errors while processing. - * - * Uses NSNumber of longLongValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end -/** - * Count of entries that were processed successfully. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Total count of entries that were processed. - * - * Uses NSNumber of longLongValue. + * Metadata for DeleteSchema LRO. */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** * Operation last update time. If the operation is done, this is also the @@ -12487,109 +12832,121 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response of the ImportDocumentsRequest. If the long running operation is - * done, then this message is returned by the - * google.longrunning.Operations.response field if the operation was - * successful. + * Request for DeleteSession method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse : GTLRObject - -/** Echoes the destination for the complete errors in the request if set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest : GTLRObject -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * Required. The resource name of the Session to delete. Format: + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` + */ +@property(nonatomic, copy, nullable) NSString *name; @end /** - * Configuration of destination for Import related errors. + * Metadata related to the progress of the + * SiteSearchEngineService.DeleteSitemap operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Cloud Storage prefix for import errors. This must be an empty, existing - * Cloud Storage directory. Import errors are written to sharded files in this - * directory, one per line, as a JSON-encoded `google.rpc.Status` message. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *gcsPrefix; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Response message for IdentityMappingStoreService.ImportIdentityMappings + * Metadata related to the progress of the + * SiteSearchEngineService.DeleteTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata : GTLRObject -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Metadata related to the progress of the ImportSampleQueries operation. This - * will be returned by the google.longrunning.Operation.metadata field. + * Defines target endpoints used to connect to third-party sources. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig : GTLRObject -/** ImportSampleQueries operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. The destinations for the corresponding key. */ +@property(nonatomic, strong, nullable) NSArray *destinations; /** - * Count of SampleQuerys that failed to be imported. - * - * Uses NSNumber of longLongValue. + * Additional parameters for this destination config in json string format. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *jsonParams; /** - * Count of SampleQuerys successfully imported. - * - * Uses NSNumber of longLongValue. + * Optional. Unique destination identifier that is supported by the connector. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, copy, nullable) NSString *key; /** - * Total count of SampleQuerys that were processed. - * - * Uses NSNumber of longLongValue. + * Optional. Additional parameters for this destination config in structured + * json format. */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig_Params *params; + +@end + /** - * ImportSampleQueries operation last update time. If the operation is done, - * this is also the finish time. + * Optional. Additional parameters for this destination config in structured + * json format. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfig_Params : GTLRObject @end /** - * Response of the SampleQueryService.ImportSampleQueries method. If the long - * running operation is done, this message is returned by the - * google.longrunning.Operations.response field if the operation is successful. + * Defines a target endpoint */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDestinationConfigDestination : GTLRObject -/** The desired location of errors incurred during the Import. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; +/** Publicly routable host. */ +@property(nonatomic, copy, nullable) NSString *host; -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * Optional. Target port number accepted by the destination. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *port; @end /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries - * operation. This is returned by the google.longrunning.Operation.metadata - * field. + * Metadata related to the progress of the + * SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -12604,863 +12961,896 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response message for CompletionService.ImportSuggestionDenyListEntries + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch * method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse : GTLRObject - -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; - -/** - * Count of deny list entries that failed to be imported. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *failedEntriesCount; - -/** - * Count of deny list entries successfully imported. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *importedEntriesCount; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse : GTLRObject @end /** - * Metadata related to the progress of the Import operation. This is returned - * by the google.longrunning.Operation.metadata field. + * A singleton resource of DataStore. If it's empty when DataStore is created + * and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the + * default parser will default to digital parser. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Whether chunking mode is enabled. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig *chunkingConfig; /** - * Count of entries that encountered errors while processing. - * - * Uses NSNumber of longLongValue. + * Configurations for default Document parser. If not specified, we will + * configure it as default DigitalParsingConfig, and the default parsing config + * will be applied to all file types for Document parsing. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig *defaultParsingConfig; /** - * Count of entries that were processed successfully. - * - * Uses NSNumber of longLongValue. + * The full resource name of the Document Processing Config. Format: `projects/ + * * /locations/ * /collections/ * /dataStores/ * /documentProcessingConfig`. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, copy, nullable) NSString *name; /** - * Operation last update time. If the operation is done, this is also the - * finish time. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - - -/** - * Response of the ImportUserEventsRequest. If the long running operation was - * successful, then this message is returned by the - * google.longrunning.Operations.response field if the operation was - * successful. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse : GTLRObject - -/** - * Echoes the destination for the complete errors if this field was set in the - * request. + * Map from file type to override the default parsing configuration based on + * the file type. Supported keys: * `pdf`: Override parsing config for PDF + * files, either digital parsing, ocr parsing or layout parsing is supported. * + * `html`: Override parsing config for HTML files, only digital parsing and + * layout parsing are supported. * `docx`: Override parsing config for DOCX + * files, only digital parsing and layout parsing are supported. * `pptx`: + * Override parsing config for PPTX files, only digital parsing and layout + * parsing are supported. * `xlsm`: Override parsing config for XLSM files, + * only digital parsing and layout parsing are supported. * `xlsx`: Override + * parsing config for XLSX files, only digital parsing and layout parsing are + * supported. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig_ParsingConfigOverrides *parsingConfigOverrides; -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +@end -/** - * Count of user events imported with complete existing Documents. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *joinedEventsCount; /** - * Count of user events imported, but with Document information not found in - * the existing Branch. + * Map from file type to override the default parsing configuration based on + * the file type. Supported keys: * `pdf`: Override parsing config for PDF + * files, either digital parsing, ocr parsing or layout parsing is supported. * + * `html`: Override parsing config for HTML files, only digital parsing and + * layout parsing are supported. * `docx`: Override parsing config for DOCX + * files, only digital parsing and layout parsing are supported. * `pptx`: + * Override parsing config for PPTX files, only digital parsing and layout + * parsing are supported. * `xlsm`: Override parsing config for XLSM files, + * only digital parsing and layout parsing are supported. * `xlsx`: Override + * parsing config for XLSX files, only digital parsing and layout parsing are + * supported. * - * Uses NSNumber of longLongValue. + * @note This class is documented as having more properties of + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig. + * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get + * the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *unjoinedEventsCount; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig_ParsingConfigOverrides : GTLRObject @end /** - * A floating point interval. + * Configuration for chunking config. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaInterval : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig : GTLRObject + +/** Configuration for the layout based chunking. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig *layoutBasedChunkingConfig; + +@end -/** - * Exclusive upper bound. - * - * Uses NSNumber of doubleValue. - */ -@property(nonatomic, strong, nullable) NSNumber *exclusiveMaximum; /** - * Exclusive lower bound. - * - * Uses NSNumber of doubleValue. + * Configuration for the layout based chunking. */ -@property(nonatomic, strong, nullable) NSNumber *exclusiveMinimum; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig : GTLRObject /** - * Inclusive upper bound. + * The token size limit for each chunk. Supported values: 100-500 (inclusive). + * Default value: 500. * - * Uses NSNumber of doubleValue. + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *maximum; +@property(nonatomic, strong, nullable) NSNumber *chunkSize; /** - * Inclusive lower bound. + * Whether to include appending different levels of headings to chunks from the + * middle of the document to prevent context loss. Default value: False. * - * Uses NSNumber of doubleValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *minimum; +@property(nonatomic, strong, nullable) NSNumber *includeAncestorHeadings; @end /** - * Language info for DataStore. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLanguageInfo : GTLRObject - -/** - * Output only. Language part of normalized_language_code. E.g.: `en-US` -> - * `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + * Related configurations applied to a specific type of document parser. */ -@property(nonatomic, copy, nullable) NSString *language; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig : GTLRObject -/** The language code for the DataStore. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +/** Configurations applied to digital parser. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig *digitalParsingConfig; -/** - * Output only. This is the normalized form of language_code. E.g.: - * language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have - * normalized_language_code of `en-GB`. - */ -@property(nonatomic, copy, nullable) NSString *normalizedLanguageCode; +/** Configurations applied to layout parser. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig *layoutParsingConfig; /** - * Output only. Region part of normalized_language_code, if present. E.g.: - * `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + * Configurations applied to OCR parser. Currently it only applies to PDFs. */ -@property(nonatomic, copy, nullable) NSString *region; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig *ocrParsingConfig; @end /** - * Request for ListSessions method. + * The digital parsing configurations for documents. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaListSessionsRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig : GTLRObject +@end + /** - * A comma-separated list of fields to filter by, in EBNF grammar. The - * supported fields are: * `user_pseudo_id` * `state` * `display_name` * - * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: - * * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = - * true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > - * "1970-01-01T12:00:00Z"` + * The layout parsing configurations for documents. */ -@property(nonatomic, copy, nullable) NSString *filter; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig : GTLRObject /** - * A comma-separated list of fields to order by, sorted in ascending order. Use - * "desc" after a field name for descending. Supported fields: * `update_time` - * * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` - * * `create_time` * `is_pinned desc,update_time desc`: list sessions by - * is_pinned first, then by update_time. + * Optional. If true, the processed document will be made available for the + * GetProcessedDocument API. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *orderBy; +@property(nonatomic, strong, nullable) NSNumber *enableGetProcessedDocument; /** - * Maximum number of results to return. If unspecified, defaults to 50. Max - * allowed value is 1000. + * Optional. If true, the LLM based annotation is added to the image during + * parsing. * - * Uses NSNumber of intValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *pageSize; +@property(nonatomic, strong, nullable) NSNumber *enableImageAnnotation; /** - * A page token, received from a previous `ListSessions` call. Provide this to - * retrieve the subsequent page. + * Optional. If true, the LLM based annotation is added to the table during + * parsing. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *pageToken; +@property(nonatomic, strong, nullable) NSNumber *enableTableAnnotation; + +/** Optional. List of HTML classes to exclude from the parsed content. */ +@property(nonatomic, strong, nullable) NSArray *excludeHtmlClasses; + +/** Optional. List of HTML elements to exclude from the parsed content. */ +@property(nonatomic, strong, nullable) NSArray *excludeHtmlElements; + +/** Optional. List of HTML ids to exclude from the parsed content. */ +@property(nonatomic, strong, nullable) NSArray *excludeHtmlIds; /** - * Required. The data store resource name. Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` + * Optional. Contains the required structure types to extract from the + * document. Supported values: * `shareholder-structure` */ -@property(nonatomic, copy, nullable) NSString *parent; +@property(nonatomic, strong, nullable) NSArray *structuredContentTypes; @end /** - * Response for ListSessions method. - * - * @note This class supports NSFastEnumeration and indexed subscripting over - * its "sessions" property. If returned as the result of a query, it - * should support automatic pagination (when @c shouldFetchNextPages is - * enabled). + * The OCR parsing configurations for documents. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaListSessionsResponse : GTLRCollectionObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig : GTLRObject -/** Pagination token, if not returned indicates the last page. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; +/** + * [DEPRECATED] This field is deprecated. To use the additional enhanced + * document elements processing, please switch to `layout_parsing_config`. + */ +@property(nonatomic, strong, nullable) NSArray *enhancedDocumentElements GTLR_DEPRECATED; /** - * All the Sessions for a given data store. + * If true, will use native text instead of OCR text on pages containing native + * text. * - * @note This property is used to support NSFastEnumeration and indexed - * subscripting on this class. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *sessions; +@property(nonatomic, strong, nullable) NSNumber *useNativeText; @end /** - * Configuration for Natural Language Query Understanding. + * Metadata related to the progress of the + * SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Mode of Natural Language Query Understanding. If this field is unset, the - * behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_Disabled - * Natural Language Query Understanding is disabled. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_Enabled - * Natural Language Query Understanding is enabled. (Value: "ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_ModeUnspecified - * Default value. (Value: "MODE_UNSPECIFIED") + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *mode; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Response message for CrawlRateManagementService.ObtainCrawlRate method. The - * response contains organcic or dedicated crawl rate time series data for - * monitoring, depending on whether dedicated crawl rate is set. + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch + * method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse : GTLRObject +@end + /** - * The historical dedicated crawl rate timeseries data, used for monitoring. + * Metadata that describes the training and serving parameters of an Engine. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries *dedicatedCrawlRateTimeSeries; - -/** Errors from service when handling the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; - -/** The historical organic crawl rate timeseries data, used for monitoring. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries *organicCrawlRateTimeSeries; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine : GTLRObject /** - * Output only. The state of the response. + * Optional. Immutable. This the application type which this engine resource + * represents. NOTE: this is a new concept independ of existing industry + * vertical or solution type. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse_State_Failed - * The state is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse_State_StateUnspecified - * The state is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse_State_Succeeded - * The state is successful. (Value: "SUCCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeIntranet + * App type for intranet search and Agentspace. (Value: + * "APP_TYPE_INTRANET") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_AppType_AppTypeUnspecified + * All non specified apps. (Value: "APP_TYPE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *state; - -@end - - -/** - * The historical organic crawl rate timeseries data, used for monitoring. - * Organic crawl is auto-determined by Google to crawl the user's website when - * dedicate crawl is not set. Crawl rate is the QPS of crawl request Google - * sends to the user's website. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries : GTLRObject +@property(nonatomic, copy, nullable) NSString *appType; /** - * Google's organic crawl rate time series, which is the sum of all googlebots' - * crawl rate. Please refer to - * https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers - * for more details about googlebots. + * Configurations for the Chat Engine. Only applicable if solution_type is + * SOLUTION_TYPE_CHAT. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *googleOrganicCrawlRate; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig *chatEngineConfig; /** - * Vertex AI's organic crawl rate time series, which is the crawl rate of - * Google-CloudVertexBot when dedicate crawl is not set. Please refer to - * https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot - * for more details about Google-CloudVertexBot. + * Output only. Additional information of the Chat Engine. Only applicable if + * solution_type is SOLUTION_TYPE_CHAT. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *vertexAiOrganicCrawlRate; - -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata *chatEngineMetadata; +/** Common config spec that specifies the metadata of the engine. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineCommonConfig *commonConfig; /** - * Metadata and configurations for a Google Cloud project in the service. + * Optional. Configuration for configurable billing approach. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled + * The billing approach follows configurations specified by customer. + * (Value: "CONFIGURABLE_BILLING_APPROACH_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified + * Default value. For Spark and non-Spark non-configurable billing + * approach. General pricing model. (Value: + * "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject : GTLRObject +@property(nonatomic, copy, nullable) NSString *configurableBillingApproach; -/** Output only. The timestamp when this project is created. */ +/** Output only. Timestamp the Recommendation Engine was created at. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Output only. Full resource name of the project, for example - * `projects/{project}`. Note that when making requests, project number and - * project id are both acceptable, but the server will always respond in - * project number. + * Optional. The data stores associated with this engine. For + * SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they + * can only associate with at most one data store. If solution_type is + * SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be + * associated here. Note that when used in CreateEngineRequest, one DataStore + * id must be provided as the system will use it for necessary initializations. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSArray *dataStoreIds; /** - * Output only. The timestamp when this project is successfully provisioned. - * Empty value means this project is still provisioning and is not ready for - * use. + * Optional. Whether to disable analytics for searches performed on this + * engine. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *provisionCompletionTime; +@property(nonatomic, strong, nullable) NSNumber *disableAnalytics; /** - * Output only. A map of terms of services. The key is the `id` of - * ServiceTerms. + * Required. The display name of the engine. Should be human readable. UTF-8 + * encoded string with limit of 1024 characters. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject_ServiceTermsMap *serviceTermsMap; - -@end +@property(nonatomic, copy, nullable) NSString *displayName; +/** + * Optional. Feature config for the engine to opt in or opt out of features. + * Supported keys: * `*`: all features, if it's present, all other feature + * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * + * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * + * `people-search-org-chart` * `bi-directional-audio` * `feedback` * + * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * + * `disable-image-generation` * `disable-video-generation` * + * `disable-onedrive-upload` * `disable-talk-to-content` * + * `disable-google-drive-upload` + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_Features *features; /** - * Output only. A map of terms of services. The key is the `id` of - * ServiceTerms. + * Optional. The industry vertical that the engine registers. The restriction + * of the Engine industry vertical is based on DataStore: Vertical on Engine + * has to match vertical of the DataStore linked to the engine. * - * @note This class is documented as having more properties of - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms. - * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get - * the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_Generic + * The generic vertical for documents that are not specific to any + * industry vertical. (Value: "GENERIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_HealthcareFhir + * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_IndustryVerticalUnspecified + * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_IndustryVertical_Media + * The media industry vertical. (Value: "MEDIA") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject_ServiceTermsMap : GTLRObject -@end - +@property(nonatomic, copy, nullable) NSString *industryVertical; /** - * Metadata about the terms of service. + * Configurations for the Media Engine. Only applicable on the data stores with + * solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA + * vertical. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig *mediaRecommendationEngineConfig; -/** The last time when the project agreed to the terms of service. */ -@property(nonatomic, strong, nullable) GTLRDateTime *acceptTime; +/** + * Immutable. Identifier. The fully qualified resource name of the engine. This + * field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Format: + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + * engine should be 1-63 characters, and valid characters are /a-z0-9* /. + * Otherwise, an INVALID_ARGUMENT error is returned. + */ +@property(nonatomic, copy, nullable) NSString *name; /** - * The last time when the project declined or revoked the agreement to terms of - * service. + * Output only. Additional information of a recommendation engine. Only + * applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */ -@property(nonatomic, strong, nullable) GTLRDateTime *declineTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata *recommendationMetadata; /** - * The unique identifier of this terms of service. Available terms: * - * `GA_DATA_USE_TERMS`: [Terms for data - * use](https://cloud.google.com/retail/data-use-terms). When using this as - * `id`, the acceptable version to provide is `2022-11-23`. - * - * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + * Configurations for the Search Engine. Only applicable if solution_type is + * SOLUTION_TYPE_SEARCH. */ -@property(nonatomic, copy, nullable) NSString *identifier; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig *searchEngineConfig; + +/** Additional config specs for a `similar-items` engine. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig *similarDocumentsConfig; /** - * Whether the project has accepted/rejected the service terms or it is still - * pending. + * Required. The solutions of the engine. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_StateUnspecified - * The default value of the enum. This value is not actually used. - * (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_TermsAccepted - * The project has given consent to the terms of service. (Value: - * "TERMS_ACCEPTED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_TermsDeclined - * The project has declined or revoked the agreement to terms of service. - * (Value: "TERMS_DECLINED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_TermsPending - * The project is pending to review and accept the terms of service. - * (Value: "TERMS_PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeChat + * Used for use cases related to the Generative AI agent. (Value: + * "SOLUTION_TYPE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeGenerativeChat + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled + * with `SOLUTION_TYPE_CHAT` solution. (Value: + * "SOLUTION_TYPE_GENERATIVE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeRecommendation + * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeSearch + * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_SolutionType_SolutionTypeUnspecified + * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, copy, nullable) NSString *solutionType; -/** - * The version string of the terms of service. For acceptable values, see the - * comments for id above. - */ -@property(nonatomic, copy, nullable) NSString *version; +/** Output only. Timestamp the Recommendation Engine was last updated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Metadata associated with a project provision operation. + * Optional. Feature config for the engine to opt in or opt out of features. + * Supported keys: * `*`: all features, if it's present, all other feature + * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * + * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * + * `people-search-org-chart` * `bi-directional-audio` * `feedback` * + * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * + * `disable-image-generation` * `disable-video-generation` * + * `disable-onedrive-upload` * `disable-talk-to-content` * + * `disable-google-drive-upload` + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngine_Features : GTLRObject @end /** - * Metadata related to the progress of the PurgeCompletionSuggestions - * operation. This is returned by the google.longrunning.Operation.metadata - * field. + * Configurations for a Chat Engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The configurationt generate the Dialogflow agent that is associated to this + * Engine. Note that these configurations are one-time consumed by and passed + * to Dialogflow service. It means they cannot be retrieved using + * EngineService.GetEngine or EngineService.ListEngines API after engine + * creation. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig *agentCreationConfig; /** - * Response message for CompletionService.PurgeCompletionSuggestions method. + * Optional. If the flag set to true, we allow the agent and engine are in + * different locations, otherwise the agent and engine are required to be in + * the same location. The flag is set to false by default. Note that the + * `allow_cross_region` are one-time consumed by and passed to + * EngineService.CreateEngine. It means they cannot be retrieved using + * EngineService.GetEngine or EngineService.ListEngines API after engine + * creation. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse : GTLRObject - -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +@property(nonatomic, strong, nullable) NSNumber *allowCrossRegion; /** - * Whether the completion suggestions were successfully purged. - * - * Uses NSNumber of boolValue. + * The resource name of an exist Dialogflow agent to link to this Chat Engine. + * Customers can either provide `agent_creation_config` to create agent or + * provide an agent name that links the agent with the Chat engine. Format: + * `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are + * one-time consumed by and passed to Dialogflow service. It means they cannot + * be retrieved using EngineService.GetEngine or EngineService.ListEngines API + * after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual + * agent association after Engine is created. */ -@property(nonatomic, strong, nullable) NSNumber *purgeSucceeded; +@property(nonatomic, copy, nullable) NSString *dialogflowAgentToLink; @end /** - * Metadata related to the progress of the PurgeDocuments operation. This will - * be returned by the google.longrunning.Operation.metadata field. + * Configurations for generating a Dialogflow agent. Note that these + * configurations are one-time consumed by and passed to Dialogflow service. It + * means they cannot be retrieved using EngineService.GetEngine or + * EngineService.ListEngines API after engine creation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig : GTLRObject /** - * Count of entries that encountered errors while processing. - * - * Uses NSNumber of longLongValue. + * Name of the company, organization or other entity that the agent represents. + * Used for knowledge connector LLM prompt and for knowledge search. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *business; /** - * Count of entries that were ignored as entries were not found. - * - * Uses NSNumber of longLongValue. + * Required. The default language of the agent as a language tag. See [Language + * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a + * list of the currently supported language codes. */ -@property(nonatomic, strong, nullable) NSNumber *ignoredCount; +@property(nonatomic, copy, nullable) NSString *defaultLanguageCode; /** - * Count of entries that were deleted successfully. - * - * Uses NSNumber of longLongValue. + * Agent location for Agent creation, supported values: global/us/eu. If not + * provided, us Engine will create Agent using us-central-1 by default; eu + * Engine will create Agent using eu-west-1 by default. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, copy, nullable) NSString *location; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Required. The time zone of the agent from the [time zone + * database](https://www.iana.org/time-zones), e.g., America/New_York, + * Europe/Paris. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *timeZone; @end /** - * Response message for DocumentService.PurgeDocuments method. If the long - * running operation is successfully done, then this message is returned by the - * google.longrunning.Operations.response field. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse : GTLRObject - -/** - * The total count of documents purged as a result of the operation. - * - * Uses NSNumber of longLongValue. + * Additional information of a Chat Engine. Fields in this message are output + * only. */ -@property(nonatomic, strong, nullable) NSNumber *purgeCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata : GTLRObject /** - * A sample of document names that will be deleted. Only populated if `force` - * is set to false. A max of 100 names will be returned and the names are - * chosen at random. + * The resource name of a Dialogflow agent, that this Chat Engine refers to. + * Format: `projects//locations//agents/`. */ -@property(nonatomic, strong, nullable) NSArray *purgeSample; +@property(nonatomic, copy, nullable) NSString *dialogflowAgent; @end /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries - * operation. This is returned by the google.longrunning.Operation.metadata - * field. + * Common configurations for an Engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineCommonConfig : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The name of the company, business or entity that is associated with the + * engine. Setting this may help improve LLM related features. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *companyName; @end /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries - * method. + * Additional config specs for a Media Recommendation engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig : GTLRObject -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** Optional. Additional engine features config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig *engineFeaturesConfig; /** - * Number of suggestion deny list entries purged. - * - * Uses NSNumber of longLongValue. + * The optimization objective. e.g., `cvr`. This field together with + * optimization_objective describe engine metadata to use to control engine + * training and serving. Currently supported values: `ctr`, `cvr`. If not + * specified, we choose default based on engine type. Default depends on type + * of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => + * `ctr` */ -@property(nonatomic, strong, nullable) NSNumber *purgeCount; - -@end - +@property(nonatomic, copy, nullable) NSString *optimizationObjective; /** - * Metadata related to the progress of the PurgeUserEvents operation. This will - * be returned by the google.longrunning.Operation.metadata field. + * Name and value of the custom threshold for cvr optimization_objective. For + * target_field `watch-time`, target_field_value must be an integer value + * indicating the media progress time in seconds between (0, 86400] (excludes + * 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the + * target_field_value must be a valid float value between (0, 1.0] (excludes 0, + * includes 1.0) (e.g., 0.5). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig *optimizationObjectiveConfig; /** - * Count of entries that encountered errors while processing. + * The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). + * Since part of the cost of running the service is frequency of training - + * this can be used to determine when to train engine in order to control cost. + * If not specified: the default value for `CreateEngine` method is `TRAINING`. + * The default value for `UpdateEngine` method is to keep the state the same as + * before. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig_TrainingState_Paused + * The engine training is paused. (Value: "PAUSED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig_TrainingState_Training + * The engine is training. (Value: "TRAINING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig_TrainingState_TrainingStateUnspecified + * Unspecified training state. (Value: "TRAINING_STATE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *trainingState; /** - * Count of entries that were deleted successfully. - * - * Uses NSNumber of longLongValue. + * Required. The type of engine. e.g., `recommended-for-you`. This field + * together with optimization_objective describe engine metadata to use to + * control engine training and serving. Currently supported values: + * `recommended-for-you`, `others-you-may-like`, `more-like-this`, + * `most-popular-items`. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, copy, nullable) NSString *type; + +@end + /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * More feature configs of the selected engine type. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig : GTLRObject + +/** Most popular engine feature config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig *mostPopularConfig; + +/** Recommended for you engine feature config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig *recommendedForYouConfig; @end /** - * Response of the PurgeUserEventsRequest. If the long running operation is - * successfully done, then this message is returned by the - * google.longrunning.Operations.response field. + * Feature configurations that are required for creating a Most Popular engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig : GTLRObject /** - * The total count of events purged as a result of the operation. + * The time window of which the engine is queried at training and prediction + * time. Positive integers only. The value translates to the last X days of + * events. Currently required for the `most-popular-items` engine. * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *purgeCount; +@property(nonatomic, strong, nullable) NSNumber *timeWindowDays; @end /** - * Describes the metrics produced by the evaluation. + * Custom threshold for `cvr` optimization_objective. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetrics : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig : GTLRObject /** - * Normalized discounted cumulative gain (NDCG) per document, at various top-k - * cutoff levels. NDCG measures the ranking quality, giving higher relevance to - * top results. Example (top-3): Suppose SampleQuery with three retrieved - * documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 - * for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 - * (1), D3 (0)] Calculate NDCG\@3 for each SampleQuery: * DCG\@3: 0/log2(1+1) + - * 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + - * 0/log2(3+1) = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 + * Required. The name of the field to target. Currently supported values: + * `watch-percentage`, `watch-time`. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *docNdcg; +@property(nonatomic, copy, nullable) NSString *targetField; /** - * Precision per document, at various top-k cutoff levels. Precision is the - * fraction of retrieved documents that are relevant. Example (top-5): * For a - * single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are - * relevant, precision\@5 = 4/5 = 0.8 + * Required. The threshold to be applied to the target (e.g., 0.5). + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *docPrecision; +@property(nonatomic, strong, nullable) NSNumber *targetFieldValueFloat; + +@end -/** - * Recall per document, at various top-k cutoff levels. Recall is the fraction - * of relevant documents retrieved out of all relevant documents. Example - * (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are - * retrieved in the top-5, recall\@5 = 3/5 = 0.6 - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *docRecall; /** - * Normalized discounted cumulative gain (NDCG) per page, at various top-k - * cutoff levels. NDCG measures the ranking quality, giving higher relevance to - * top results. Example (top-3): Suppose SampleQuery with three retrieved pages - * (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not - * relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 - * (0)] Calculate NDCG\@3 for SampleQuery: * DCG\@3: 0/log2(1+1) + 1/log2(2+1) - * + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) - * = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 + * Additional feature configurations for creating a `recommended-for-you` + * engine. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *pageNdcg; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig : GTLRObject /** - * Recall per page, at various top-k cutoff levels. Recall is the fraction of - * relevant pages retrieved out of all relevant pages. Example (top-5): * For a - * single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, - * recall\@5 = 3/5 = 0.6 + * The type of event with which the engine is queried at prediction time. If + * set to `generic`, only `view-item`, `media-play`,and `media-complete` will + * be used as `context-event` in engine training. If set to `view-home-page`, + * `view-home-page` will also be used as `context-events` in addition to + * `view-item`, `media-play`, and `media-complete`. Currently supported for the + * `recommended-for-you` engine. Currently supported values: `view-home-page`, + * `generic`. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *pageRecall; +@property(nonatomic, copy, nullable) NSString *contextEventType; @end /** - * Stores the metric values at specific top-k levels. + * Additional information of a recommendation engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata : GTLRObject /** - * The top-1 value. + * Output only. The state of data requirements for this engine: `DATA_OK` and + * `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. + * Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: + * engines were trained successfully before, but cannot be refreshed because + * the underlying engine no longer has sufficient data for training. * - * Uses NSNumber of doubleValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_DataState_DataError + * The engine does not have sufficient training data. Error messages can + * be queried via Stackdriver. (Value: "DATA_ERROR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_DataState_DataOk + * The engine has sufficient training data. (Value: "DATA_OK") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_DataState_DataStateUnspecified + * Unspecified default value, should never be explicitly set. (Value: + * "DATA_STATE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *top1; +@property(nonatomic, copy, nullable) NSString *dataState; /** - * The top-10 value. - * - * Uses NSNumber of doubleValue. + * Output only. The timestamp when the latest successful training finished. + * Only applicable on Media Recommendation engines. */ -@property(nonatomic, strong, nullable) NSNumber *top10; +@property(nonatomic, strong, nullable) GTLRDateTime *lastTrainTime; /** - * The top-3 value. - * - * Uses NSNumber of doubleValue. + * Output only. The timestamp when the latest successful tune finished. Only + * applicable on Media Recommendation engines. */ -@property(nonatomic, strong, nullable) NSNumber *top3; +@property(nonatomic, strong, nullable) GTLRDateTime *lastTuneTime; /** - * The top-5 value. + * Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. * - * Uses NSNumber of doubleValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_Active + * The engine is serving and can be queried. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_Inactive + * The engine is not serving. (Value: "INACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_ServingStateUnspecified + * Unspecified serving state. (Value: "SERVING_STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata_ServingState_Tuned + * The engine is trained on tuned hyperparameters and can be queried. + * (Value: "TUNED") */ -@property(nonatomic, strong, nullable) NSNumber *top5; +@property(nonatomic, copy, nullable) NSString *servingState; + +/** + * Output only. The latest tune operation id associated with the engine. Only + * applicable on Media Recommendation engines. If present, this operation id + * can be used to determine if there is an ongoing tune for this engine. To + * check the operation status, send the GetOperation request with this + * operation id in the engine resource format. If no tuning has happened for + * this engine, the string is empty. + */ +@property(nonatomic, copy, nullable) NSString *tuningOperation; @end /** - * Defines a user inputed query. + * Configurations for a Search Engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQuery : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig : GTLRObject -/** Output only. Unique Id for the query. */ -@property(nonatomic, copy, nullable) NSString *queryId; +/** The add-on that this search engine enables. */ +@property(nonatomic, strong, nullable) NSArray *searchAddOns; -/** Plain text. */ -@property(nonatomic, copy, nullable) NSString *text; +/** + * The search feature tier of this engine. Different tiers might have different + * pricing. To learn more, check the pricing documentation. Defaults to + * SearchTier.SEARCH_TIER_STANDARD if not specified. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig_SearchTier_SearchTierEnterprise + * Enterprise tier. (Value: "SEARCH_TIER_ENTERPRISE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig_SearchTier_SearchTierStandard + * Standard tier. (Value: "SEARCH_TIER_STANDARD") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig_SearchTier_SearchTierUnspecified + * Default value when the enum is unspecified. This is invalid to use. + * (Value: "SEARCH_TIER_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *searchTier; @end /** - * Metadata related to the progress of the SiteSearchEngineService.RecrawlUris - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Additional config specs for a `similar-items` engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig : GTLRObject +@end -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Unique URIs in the request that have invalid format. Sample limited to 1000. + * Metadata related to the progress of the EstimateDataSize operation. This is + * returned by the google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) NSArray *invalidUris; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +@end + /** - * Total number of unique URIs in the request that have invalid format. - * - * Uses NSNumber of intValue. + * Response of the EstimateDataSize request. If the long running operation was + * successful, then this message is returned by the + * google.longrunning.Operations.response field if the operation was + * successful. */ -@property(nonatomic, strong, nullable) NSNumber *invalidUrisCount; - -/** URIs that have no index meta tag. Sample limited to 1000. */ -@property(nonatomic, strong, nullable) NSArray *noindexUris; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse : GTLRObject /** - * Total number of URIs that have no index meta tag. + * Data size in terms of bytes. * - * Uses NSNumber of intValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *noindexUrisCount; +@property(nonatomic, strong, nullable) NSNumber *dataSizeBytes; /** - * Total number of URIs that have yet to be crawled. + * Total number of documents. * - * Uses NSNumber of intValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *pendingCount; +@property(nonatomic, strong, nullable) NSNumber *documentCount; + +@end + /** - * Total number of URIs that were rejected due to insufficient indexing - * resources. - * - * Uses NSNumber of intValue. + * An evaluation is a single execution (or run) of an evaluation process. It + * encapsulates the state of the evaluation and the resulting data. */ -@property(nonatomic, strong, nullable) NSNumber *quotaExceededCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation : GTLRObject + +/** Output only. Timestamp the Evaluation was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** Output only. Timestamp the Evaluation was completed at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; /** - * Total number of URIs that have been crawled so far. - * - * Uses NSNumber of intValue. + * Output only. The error that occurred during evaluation. Only populated when + * the evaluation's state is FAILED. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Output only. A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** Required. The specification of the evaluation. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec *evaluationSpec; /** - * Unique URIs in the request that don't match any TargetSite in the DataStore, - * only match TargetSites that haven't been fully indexed, or match a - * TargetSite with type EXCLUDE. Sample limited to 1000. + * Identifier. The full resource name of the Evaluation, in the format of + * `projects/{project}/locations/{location}/evaluations/{evaluation}`. This + * field must be a UTF-8 encoded string with a length limit of 1024 characters. */ -@property(nonatomic, strong, nullable) NSArray *urisNotMatchingTargetSites; +@property(nonatomic, copy, nullable) NSString *name; /** - * Total number of URIs that don't match any TargetSites. - * - * Uses NSNumber of intValue. + * Output only. The metrics produced by the evaluation, averaged across all + * SampleQuerys in the SampleQuerySet. Only populated when the evaluation's + * state is SUCCEEDED. */ -@property(nonatomic, strong, nullable) NSNumber *urisNotMatchingTargetSitesCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetrics *qualityMetrics; /** - * Total number of unique URIs in the request that are not in invalid_uris. + * Output only. The state of the evaluation. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Failed + * The evaluation failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Pending + * The service is preparing to run the evaluation. (Value: "PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Running + * The evaluation is in progress. (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_StateUnspecified + * The evaluation is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluation_State_Succeeded + * The evaluation completed successfully. (Value: "SUCCEEDED") */ -@property(nonatomic, strong, nullable) NSNumber *validUrisCount; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Response message for SiteSearchEngineService.RecrawlUris method. + * Describes the specification of the evaluation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse : GTLRObject - -/** URIs that were not crawled before the LRO terminated. */ -@property(nonatomic, strong, nullable) NSArray *failedUris; - -/** Details for a sample of up to 10 `failed_uris`. */ -@property(nonatomic, strong, nullable) NSArray *failureSamples; - -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec : GTLRObject +/** Optional. The specification of the query set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec *querySetSpec; /** - * Details about why a particular URI failed to be crawled. Each FailureInfo - * contains one FailureReason per CorpusType. + * Required. The search request that is used to perform the evaluation. Only + * the following fields within SearchRequest are supported; if any other fields + * are provided, an UNSUPPORTED error will be returned: * + * SearchRequest.serving_config * SearchRequest.branch * + * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * + * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * + * SearchRequest.user_pseudo_id */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo : GTLRObject - -/** List of failure reasons by corpus type (e.g. desktop, mobile). */ -@property(nonatomic, strong, nullable) NSArray *failureReasons; - -/** URI that failed to be crawled. */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest *searchRequest; @end /** - * Details about why crawling failed for a particular CorpusType, e.g., DESKTOP - * and MOBILE crawling may fail for different reasons. + * Describes the specification of the query set. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec : GTLRObject /** - * DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason_CorpusType_CorpusTypeUnspecified - * Default value. (Value: "CORPUS_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason_CorpusType_Desktop - * Denotes a crawling attempt for the desktop version of a page. (Value: - * "DESKTOP") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason_CorpusType_Mobile - * Denotes a crawling attempt for the mobile version of a page. (Value: - * "MOBILE") + * Optional. The full resource name of the SampleQuerySet used for the + * evaluation, in the format of + * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */ -@property(nonatomic, copy, nullable) NSString *corpusType; - -/** Reason why the URI was not crawled. */ -@property(nonatomic, copy, nullable) NSString *errorMessage; +@property(nonatomic, copy, nullable) NSString *sampleQuerySet; @end /** - * Metadata related to the progress of the - * CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the Export operation. This is returned + * by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -13475,1764 +13865,1557 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate - * method. It simply returns the state of the response, and an error message if - * the state is FAILED. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse : GTLRObject - -/** Errors from service when handling the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; - -/** - * Output only. The state of the response. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse_State_Failed - * The state is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse_State_StateUnspecified - * The state is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse_State_Succeeded - * The state is successful. (Value: "SUCCEEDED") + * Response of the ExportMetricsRequest. If the long running operation was + * successful, then this message is returned by the + * google.longrunning.Operations.response field. */ -@property(nonatomic, copy, nullable) NSString *state; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaExportMetricsResponse : GTLRObject @end /** - * Safety rating corresponding to the generated content. + * Configurations for fields of a schema. For example, configuring a field is + * indexable, or searchable. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig : GTLRObject /** - * Output only. Indicates whether the content was filtered out because of this - * rating. - * - * Uses NSNumber of boolValue. + * If this field is set, only the corresponding source will be indexed for this + * field. Otherwise, the values from different sources are merged. Assuming a + * page with `` in meta tag, and `` in page map: if this enum is set to + * METATAGS, we will only index ``; if this enum is not set, we will merge them + * and index ``. */ -@property(nonatomic, strong, nullable) NSNumber *blocked; +@property(nonatomic, strong, nullable) NSArray *advancedSiteSearchDataSources; /** - * Output only. Harm category. + * If completable_option is COMPLETABLE_ENABLED, field values are directly used + * and returned as suggestions for Autocomplete in + * CompletionService.CompleteQuery. If completable_option is unset, the server + * behavior defaults to COMPLETABLE_DISABLED for fields that support setting + * completable options, which are just `string` fields. For those fields that + * do not support setting completable options, the server will skip completable + * option setting, and setting completable_option for those fields will throw + * `INVALID_ARGUMENT` error. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryCivicIntegrity - * The harm category is civic integrity. (Value: - * "HARM_CATEGORY_CIVIC_INTEGRITY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryDangerousContent - * The harm category is dangerous content. (Value: - * "HARM_CATEGORY_DANGEROUS_CONTENT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryHarassment - * The harm category is harassment. (Value: "HARM_CATEGORY_HARASSMENT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryHateSpeech - * The harm category is hate speech. (Value: "HARM_CATEGORY_HATE_SPEECH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategorySexuallyExplicit - * The harm category is sexually explicit content. (Value: - * "HARM_CATEGORY_SEXUALLY_EXPLICIT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryUnspecified - * The harm category is unspecified. (Value: "HARM_CATEGORY_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_CompletableOption_CompletableDisabled + * Completable option disabled for a schema field. (Value: + * "COMPLETABLE_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_CompletableOption_CompletableEnabled + * Completable option enabled for a schema field. (Value: + * "COMPLETABLE_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_CompletableOption_CompletableOptionUnspecified + * Value used when unset. (Value: "COMPLETABLE_OPTION_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *category; +@property(nonatomic, copy, nullable) NSString *completableOption; /** - * Output only. Harm probability levels in the content. + * If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are + * available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if + * FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an + * `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is + * unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields + * that support setting dynamic facetable options. For those fields that do not + * support setting dynamic facetable options, such as `object` and `boolean`, + * the server will skip dynamic facetable option setting, and setting + * dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` + * error. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_HarmProbabilityUnspecified - * Harm probability unspecified. (Value: "HARM_PROBABILITY_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_High - * High level of harm. (Value: "HIGH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_Low - * Low level of harm. (Value: "LOW") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_Medium - * Medium level of harm. (Value: "MEDIUM") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_Negligible - * Negligible level of harm. (Value: "NEGLIGIBLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_DynamicFacetableOption_DynamicFacetableDisabled + * Dynamic facetable option disabled for a schema field. (Value: + * "DYNAMIC_FACETABLE_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_DynamicFacetableOption_DynamicFacetableEnabled + * Dynamic facetable option enabled for a schema field. (Value: + * "DYNAMIC_FACETABLE_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_DynamicFacetableOption_DynamicFacetableOptionUnspecified + * Value used when unset. (Value: "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *probability; +@property(nonatomic, copy, nullable) NSString *dynamicFacetableOption; /** - * Output only. Harm probability score. - * - * Uses NSNumber of floatValue. + * Required. Field path of the schema field. For example: `title`, + * `description`, `release_info.release_year`. */ -@property(nonatomic, strong, nullable) NSNumber *probabilityScore; +@property(nonatomic, copy, nullable) NSString *fieldPath; /** - * Output only. Harm severity levels in the content. + * Output only. Raw type of the field. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityHigh - * High level of harm severity. (Value: "HARM_SEVERITY_HIGH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityLow - * Low level of harm severity. (Value: "HARM_SEVERITY_LOW") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityMedium - * Medium level of harm severity. (Value: "HARM_SEVERITY_MEDIUM") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityNegligible - * Negligible level of harm severity. (Value: "HARM_SEVERITY_NEGLIGIBLE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityUnspecified - * Harm severity unspecified. (Value: "HARM_SEVERITY_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Boolean + * Field value type is Boolean. (Value: "BOOLEAN") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Datetime + * Field value type is Datetime. Datetime can be expressed as either: * a + * number representing milliseconds-since-the-epoch * a string + * representing milliseconds-since-the-epoch. e.g. `"1420070400001"` * a + * string representing the [ISO + * 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. + * e.g. `"2015-01-01"` or `"2015-01-01T12:10:30Z"` (Value: "DATETIME") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_FieldTypeUnspecified + * Field type is unspecified. (Value: "FIELD_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Geolocation + * Field value type is Geolocation. Geolocation is expressed as an object + * with the following keys: * `id`: a string representing the location id + * * `longitude`: a number representing the longitude coordinate of the + * location * `latitude`: a number repesenting the latitude coordinate of + * the location * `address`: a string representing the full address of + * the location `latitude` and `longitude` must always be provided + * together. At least one of a) `address` or b) `latitude`-`longitude` + * pair must be provided. (Value: "GEOLOCATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Integer + * Field value type is Integer. (Value: "INTEGER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Number + * Field value type is Number. (Value: "NUMBER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_Object + * Field value type is Object. (Value: "OBJECT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_FieldType_String + * Field value type is String. (Value: "STRING") */ -@property(nonatomic, copy, nullable) NSString *severity; +@property(nonatomic, copy, nullable) NSString *fieldType; /** - * Output only. Harm severity score. + * If indexable_option is INDEXABLE_ENABLED, field values are indexed so that + * it can be filtered or faceted in SearchService.Search. If indexable_option + * is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that + * support setting indexable options. For those fields that do not support + * setting indexable options, such as `object` and `boolean` and key + * properties, the server will skip indexable_option setting, and setting + * indexable_option for those fields will throw `INVALID_ARGUMENT` error. * - * Uses NSNumber of floatValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_IndexableOption_IndexableDisabled + * Indexable option disabled for a schema field. (Value: + * "INDEXABLE_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_IndexableOption_IndexableEnabled + * Indexable option enabled for a schema field. (Value: + * "INDEXABLE_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_IndexableOption_IndexableOptionUnspecified + * Value used when unset. (Value: "INDEXABLE_OPTION_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *severityScore; - -@end - +@property(nonatomic, copy, nullable) NSString *indexableOption; /** - * Defines the structure and layout of a type of document data. + * Output only. Type of the key property that this field is mapped to. Empty + * string if this is not annotated as mapped to a key property. Example types + * are `title`, `description`. Full list is defined by `keyPropertyMapping` in + * the schema field annotation. If the schema field has a `KeyPropertyMapping` + * annotation, `indexable_option` and `searchable_option` of this field cannot + * be modified. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema : GTLRObject - -/** Output only. Configurations for fields of the schema. */ -@property(nonatomic, strong, nullable) NSArray *fieldConfigs; - -/** The JSON representation of the schema. */ -@property(nonatomic, copy, nullable) NSString *jsonSchema; +@property(nonatomic, copy, nullable) NSString *keyPropertyType; /** - * Immutable. The full resource name of the schema, in the format of - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. - * This field must be a UTF-8 encoded string with a length limit of 1024 - * characters. + * Optional. The metatag name found in the HTML page. If user defines this + * field, the value of this metatag name will be used to extract metatag. If + * the user does not define this field, the FieldConfig.field_path will be used + * to extract metatag. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** The structured representation of the schema. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema_StructSchema *structSchema; - -@end - +@property(nonatomic, copy, nullable) NSString *metatagName; /** - * The structured representation of the schema. + * If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable + * by filter expression in RecommendationService.Recommend. If + * FILTERABLE_ENABLED but the field type is numerical, field values are not + * filterable by text queries in RecommendationService.Recommend. Only textual + * fields are supported. If recs_filterable_option is unset, the default + * setting is FILTERABLE_DISABLED for fields that support setting filterable + * options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is + * generated and an empty result is returned. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RecsFilterableOption_FilterableDisabled + * Filterable option disabled for a schema field. (Value: + * "FILTERABLE_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RecsFilterableOption_FilterableEnabled + * Filterable option enabled for a schema field. (Value: + * "FILTERABLE_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RecsFilterableOption_FilterableOptionUnspecified + * Value used when unset. (Value: "FILTERABLE_OPTION_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema_StructSchema : GTLRObject -@end +@property(nonatomic, copy, nullable) NSString *recsFilterableOption; +/** + * If retrievable_option is RETRIEVABLE_ENABLED, field values are included in + * the search results. If retrievable_option is unset, the server behavior + * defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable + * options. For those fields that do not support setting retrievable options, + * such as `object` and `boolean`, the server will skip retrievable option + * setting, and setting retrievable_option for those fields will throw + * `INVALID_ARGUMENT` error. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RetrievableOption_RetrievableDisabled + * Retrievable option disabled for a schema field. (Value: + * "RETRIEVABLE_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RetrievableOption_RetrievableEnabled + * Retrievable option enabled for a schema field. (Value: + * "RETRIEVABLE_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_RetrievableOption_RetrievableOptionUnspecified + * Value used when unset. (Value: "RETRIEVABLE_OPTION_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *retrievableOption; /** - * Promotion proto includes uri and other helping information to display the - * promotion. + * Field paths for indexing custom attribute from schema.org data. More details + * of schema.org and its defined types can be found at + * [schema.org](https://schema.org). It is only used on advanced site search + * schema. Currently only support full path from root. The full path to a field + * is constructed by concatenating field names, starting from `_root`, with a + * period `.` as the delimiter. Examples: * Publish date of the root: + * _root.datePublished * Publish date of the reviews: + * _root.review.datePublished */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion : GTLRObject +@property(nonatomic, strong, nullable) NSArray *schemaOrgPaths; /** - * Optional. The Promotion description. Maximum length: 200 characters. + * If searchable_option is SEARCHABLE_ENABLED, field values are searchable by + * text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type + * is numerical, field values will not be searchable by text queries in + * SearchService.Search, as there are no text values associated to numerical + * fields. If searchable_option is unset, the server behavior defaults to + * SEARCHABLE_DISABLED for fields that support setting searchable options. Only + * `string` fields that have no key property mapping support setting + * searchable_option. For those fields that do not support setting searchable + * options, the server will skip searchable option setting, and setting + * searchable_option for those fields will throw `INVALID_ARGUMENT` error. * - * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_SearchableOption_SearchableDisabled + * Searchable option disabled for a schema field. (Value: + * "SEARCHABLE_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_SearchableOption_SearchableEnabled + * Searchable option enabled for a schema field. (Value: + * "SEARCHABLE_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaFieldConfig_SearchableOption_SearchableOptionUnspecified + * Value used when unset. (Value: "SEARCHABLE_OPTION_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *descriptionProperty; +@property(nonatomic, copy, nullable) NSString *searchableOption; + +@end + /** - * Optional. The Document the user wants to promote. For site search, leave - * unset and only populate uri. Can be set along with uri. + * Request for GetSession method. */ -@property(nonatomic, copy, nullable) NSString *document; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetSessionRequest : GTLRObject /** - * Optional. The enabled promotion will be returned for any serving configs - * associated with the parent of the control this promotion is attached to. - * This flag is used for basic site search only. + * Optional. If set to true, the full session including all answer details will + * be returned. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *enabled; - -/** Optional. The promotion thumbnail image url. */ -@property(nonatomic, copy, nullable) NSString *imageUri; - -/** Required. The title of the promotion. Maximum length: 160 characters. */ -@property(nonatomic, copy, nullable) NSString *title; +@property(nonatomic, strong, nullable) NSNumber *includeAnswerDetails; /** - * Optional. The URL for the page the user wants to promote. Must be set for - * site search. For other verticals, this is optional. + * Required. The resource name of the Session to get. Format: + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, copy, nullable) NSString *name; @end /** - * Request message for SearchService.Search method. + * Response message for SiteSearchEngineService.GetUriPatternDocumentData + * method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse : GTLRObject /** - * Boost specification to boost certain documents. For more information on - * boosting, see - * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + * Document data keyed by URI pattern. For example: document_data_map = { + * "www.url1.com/ *": { "Categories": ["category1", "category2"] }, + * "www.url2.com/ *": { "Categories": ["category3"] } } */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec *boostSpec; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap *documentDataMap; + +@end + /** - * The branch resource name, such as `projects/ * - * /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. - * Use `default_branch` as the branch ID or leave this field empty, to search - * documents under the default branch. + * Document data keyed by URI pattern. For example: document_data_map = { + * "www.url1.com/ *": { "Categories": ["category1", "category2"] }, + * "www.url2.com/ *": { "Categories": ["category3"] } } + * + * @note This class is documented as having more properties of + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap_DocumentDataMap. + * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get + * the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *branch; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap : GTLRObject +@end + /** - * The default filter that is applied when a user performs a search without - * checking any filters on the search page. The filter applied to every search - * request when quality improvement such as query expansion is needed. In the - * case a query does not have a sufficient amount of results this filter will - * be used to determine whether or not to enable the query expansion flow. The - * original filter will still be used for the query expanded search. This field - * is strongly recommended to achieve high search quality. For more information - * about filter syntax, see SearchRequest.filter. + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap_DocumentDataMap + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *canonicalFilter; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse_DocumentDataMap_DocumentDataMap : GTLRObject +@end -/** A specification for configuring the behavior of content search. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec *contentSearchSpec; /** - * Custom fine tuning configs. If set, it has higher priority than the configs - * set in ServingConfig.custom_fine_tuning_spec. + * Config to data store for `HEALTHCARE_FHIR` vertical. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec *customFineTuningSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig : GTLRObject /** - * Specifications that define the specific DataStores to be searched, along - * with configurations for those data stores. This is only considered for - * Engines with multiple data stores. For engines with a single data store, the - * specs directly under SearchRequest should be used. + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set + * to `true`, the predefined healthcare fhir schema can be extended for more + * customized searching and filtering. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *dataStoreSpecs; +@property(nonatomic, strong, nullable) NSNumber *enableConfigurableSchema; /** - * Optional. Config for display feature, like match highlighting on search - * results. + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If + * set to `true`, the batch ingestion will be processed in a static indexing + * mode which is slower but more capable of handling larger volume. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec *displaySpec; +@property(nonatomic, strong, nullable) NSNumber *enableStaticIndexingForBatchIngestion; + +@end + /** - * Uses the provided embedding to do additional semantic document retrieval. - * The retrieval is based on the dot product of - * SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document - * embedding that is provided in - * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If - * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it - * will use ServingConfig.EmbeddingConfig.field_path. + * IdentityMappingEntry LongRunningOperation metadata for + * IdentityMappingStoreService.ImportIdentityMappings and + * IdentityMappingStoreService.PurgeIdentityMappings */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec *embeddingSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata : GTLRObject /** - * Facet specifications for faceted search. If empty, no facets are returned. A - * maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is - * returned. + * The number of IdentityMappingEntries that failed to be processed. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *facetSpecs; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * The filter syntax consists of an expression language for constructing a - * predicate from one or more fields of the documents being filtered. Filter - * expression is case-sensitive. If this field is unrecognizable, an - * `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by - * mapping the LHS filter key to a key property defined in the Vertex AI Search - * backend -- this mapping is defined by the customer in their schema. For - * example a media customer might have a field 'name' in their schema. In this - * case the filter would look like this: filter --> name:'ANY("king kong")' For - * more information about filtering including syntax and filter operators, see - * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * The number of IdentityMappingEntries that were successfully processed. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *filter; - -/** Raw image query. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery *imageQuery; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more - * information, see [Standard - * fields](https://cloud.google.com/apis/design/standard_fields). This field - * helps to better interpret the query. If a value isn't specified, the query - * language code is automatically detected, which may not be accurate. + * The total number of IdentityMappingEntries that were processed. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +@property(nonatomic, strong, nullable) NSNumber *totalCount; + +@end + /** - * Config for natural language query understanding capabilities, such as - * extracting structured field filters from the query. Refer to [this - * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) - * for more information. If `naturalLanguageQueryUnderstandingSpec` is not - * specified, no additional natural language query understanding will be done. + * The configuration for the identity data synchronization runs. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec *naturalLanguageQueryUnderstandingSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig : GTLRObject /** - * A 0-indexed integer that specifies the current offset (that is, starting - * result location, amongst the Documents deemed by the API as relevant) in - * search results. This field is only considered if page_token is unset. If - * this field is negative, an `INVALID_ARGUMENT` is returned. - * - * Uses NSNumber of intValue. + * Optional. The UTC time when the next data sync is expected to start for the + * Data Connector. Customers are only able to specify the hour and minute to + * schedule the data sync. This is utilized when the data connector has a + * refresh interval greater than 1 day. */ -@property(nonatomic, strong, nullable) NSNumber *offset; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDateTime *nextSyncTime; /** - * The maximum number of results to return for OneBox. This applies to each - * OneBox type individually. Default number is 10. - * - * Uses NSNumber of intValue. + * Optional. The refresh interval to sync the Access Control List information + * for the documents ingested by this connector. If not set, the access control + * list will be refreshed at the default interval of 30 minutes. The identity + * refresh interval can be at least 30 minutes and at most 7 days. */ -@property(nonatomic, strong, nullable) NSNumber *oneBoxPageSize; +@property(nonatomic, strong, nullable) GTLRDuration *refreshInterval; + +@end + /** - * The order in which documents are returned. Documents can be ordered by a - * field in an Document object. Leave it unset if ordered by relevance. - * `order_by` expression is case-sensitive. For more information on ordering - * the website search results, see [Order web search - * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). - * For more information on ordering the healthcare search results, see [Order - * healthcare search - * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). - * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * Identity Provider Config. */ -@property(nonatomic, copy, nullable) NSString *orderBy; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig : GTLRObject + +/** External Identity provider config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig *externalIdpConfig; /** - * Maximum number of Documents to return. The maximum allowed value depends on - * the data type. Values above the maximum value are coerced to the maximum - * value. * Websites with basic indexing: Default `10`, Maximum `25`. * - * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: - * Default `50`, Maximum `100`. If this field is negative, an - * `INVALID_ARGUMENT` is returned. + * Identity provider type configured. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_Gsuite + * Google 1P provider. (Value: "GSUITE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_IdpTypeUnspecified + * Default value. ACL search not enabled. (Value: "IDP_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfig_IdpType_ThirdParty + * Third party provider. (Value: "THIRD_PARTY") */ -@property(nonatomic, strong, nullable) NSNumber *pageSize; +@property(nonatomic, copy, nullable) NSString *idpType; + +@end + /** - * A page token received from a previous SearchService.Search call. Provide - * this to retrieve the subsequent page. When paginating, all other parameters - * provided to SearchService.Search must match the call that provided the page - * token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Third party IDP Config. */ -@property(nonatomic, copy, nullable) NSString *pageToken; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig : GTLRObject + +/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */ +@property(nonatomic, copy, nullable) NSString *workforcePoolName; + +@end + /** - * Additional search parameters. For public website search only, supported - * values are: * `user_country_code`: string. Default empty. If set to - * non-empty, results are restricted or boosted based on the location provided. - * For example, `user_country_code: "au"` For available codes see [Country - * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - * * `search_type`: double. Default empty. Enables non-webpage searching - * depending on the value. The only valid non-default value is 1, which enables - * image searching. For example, `search_type: 1` + * Metadata related to the progress of the ImportCompletionSuggestions + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_Params *params; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The specification for personalization. Notice that if both - * ServingConfig.personalization_spec and SearchRequest.personalization_spec - * are set, SearchRequest.personalization_spec overrides - * ServingConfig.personalization_spec. + * Count of CompletionSuggestions that failed to be imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec *personalizationSpec; - -/** Raw search query. */ -@property(nonatomic, copy, nullable) NSString *query; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * The query expansion specification that specifies the conditions under which - * query expansion occurs. + * Count of CompletionSuggestions successfully imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec *queryExpansionSpec; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Optional. The ranking expression controls the customized ranking on - * retrieval documents. This overrides ServingConfig.ranking_expression. The - * syntax and supported features depend on the `ranking_expression_backend` - * value. If `ranking_expression_backend` is not provided, it defaults to - * `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to - * `RANK_BY_EMBEDDING`, it should be a single function or multiple functions - * that are joined by "+". * ranking_expression = function, { " + ", function - * }; Supported functions: * double * relevance_score * double * - * dotProduct(embedding_field_path) Function variables: * `relevance_score`: - * pre-defined keywords, used for measure relevance between query and document. - * * `embedding_field_path`: the document embedding field used with query - * embedding vector. * `dotProduct`: embedding function between - * `embedding_field_path` and query embedding vector. Example ranking - * expression: If document has an embedding field doc_embedding, the ranking - * expression could be `0.5 * relevance_score + 0.3 * - * dotProduct(doc_embedding)`. If ranking_expression_backend is set to - * `RANK_BY_FORMULA`, the following expression types (and combinations of those - * chained using + or * operators) are supported: * `double` * `signal` * - * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank - * transformation with second argument being a denominator constant. * - * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * - * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 - * | double, else returns signal1. Here are a few examples of ranking formulas - * that use the supported ranking expression types: - `0.2 * - * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly - * rank by the logarithm of `keyword_similarity_score` with slight - * `semantic_smilarity_score` adjustment. - `0.2 * - * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * - * is_nan(keyword_similarity_score)` -- rank by the exponent of - * `semantic_similarity_score` filling the value with 0 if it's NaN, also add - * constant 0.3 adjustment to the final score if `semantic_similarity_score` is - * NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * - * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of - * `keyword_similarity_score` with slight adjustment of reciprocal rank of - * `semantic_smilarity_score`. The following signals are supported: * - * `semantic_similarity_score`: semantic similarity adjustment that is - * calculated using the embeddings generated by a proprietary Google model. - * This score determines how semantically similar a search query is to a - * document. * `keyword_similarity_score`: keyword match adjustment uses the - * Best Match 25 (BM25) ranking function. This score is calculated using a - * probabilistic model to estimate the probability that a document is relevant - * to a given query. * `relevance_score`: semantic relevance adjustment that - * uses a proprietary Google model to determine the meaning and intent behind a - * user's query in context with the content in the documents. * `pctr_rank`: - * predicted conversion rate adjustment as a rank use predicted Click-through - * rate (pCTR) to gauge the relevance and attractiveness of a search result - * from a user's perspective. A higher pCTR suggests that the result is more - * likely to satisfy the user's query and intent, making it a valuable signal - * for ranking. * `freshness_rank`: freshness adjustment as a rank * - * `document_age`: The time in hours elapsed since the document was last - * updated, a floating-point number (e.g., 0.25 means 15 minutes). * - * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google - * model to determine the keyword-based overlap between the query and the - * document. * `base_rank`: the default rank of the result + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *rankingExpression; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Optional. The backend to use for the ranking expression evaluation. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_Byoe - * Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom - * embedding model, the default way to evaluate the ranking expression. - * Legacy enum option, `RANK_BY_EMBEDDING` should be used instead. - * (Value: "BYOE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_Clearbox - * Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. - * Legacy enum option, `RANK_BY_FORMULA` should be used instead. (Value: - * "CLEARBOX") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_RankByEmbedding - * Ranking by custom embedding model, the default way to evaluate the - * ranking expression. (Value: "RANK_BY_EMBEDDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_RankByFormula - * Ranking by custom formula. (Value: "RANK_BY_FORMULA") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_RankingExpressionBackendUnspecified - * Default option for unspecified/unknown values. (Value: - * "RANKING_EXPRESSION_BACKEND_UNSPECIFIED") + * Response of the CompletionService.ImportCompletionSuggestions method. If the + * long running operation is done, this message is returned by the + * google.longrunning.Operations.response field if the operation is successful. */ -@property(nonatomic, copy, nullable) NSString *rankingExpressionBackend; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse : GTLRObject + +/** The desired location of errors incurred during the Import. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +@end + /** - * The Unicode country/region code (CLDR) of a location, such as "US" and - * "419". For more information, see [Standard - * fields](https://cloud.google.com/apis/design/standard_fields). If set, then - * results will be boosted based on the region_code provided. + * Metadata related to the progress of the ImportDocuments operation. This is + * returned by the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *regionCode; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata : GTLRObject -/** Optional. The specification for returning the relevance score. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec *relevanceScoreSpec; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The relevance threshold of the search results. Default to Google defined - * threshold, leveraging a balance of precision and recall to deliver both - * highly accurate results and comprehensive coverage of relevant information. - * This feature is not supported for healthcare search. + * Count of entries that encountered errors while processing. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_High - * High relevance threshold. (Value: "HIGH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_Low - * Low relevance threshold. (Value: "LOW") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_Lowest - * Lowest relevance threshold. (Value: "LOWEST") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_Medium - * Medium relevance threshold. (Value: "MEDIUM") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_RelevanceThresholdUnspecified - * Default value. In this case, server behavior defaults to Google - * defined threshold. (Value: "RELEVANCE_THRESHOLD_UNSPECIFIED") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *relevanceThreshold; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * Whether to turn on safe search. This is only supported for website search. + * Count of entries that were processed successfully. * - * Uses NSNumber of boolValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *safeSearch; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Search as you type configuration. Only supported for the - * IndustryVertical.MEDIA vertical. + * Total count of entries that were processed. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec *searchAsYouTypeSpec; +@property(nonatomic, strong, nullable) NSNumber *totalCount; /** - * Required. The resource name of the Search serving config, such as `projects/ - * * /locations/global/collections/default_collection/engines/ * - * /servingConfigs/default_serving_config`, or `projects/ * - * /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. - * This field is used to identify the serving configuration name, set of models - * used to make the search. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *servingConfig; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** - * The session resource name. Optional. Session allows users to do multi-turn - * /search API calls or coordination between /search API calls and /answer API - * calls. Example #1 (multi-turn /search API calls): Call /search API with the - * session ID generated in the first call. Here, the previous search query gets - * considered in query standing. I.e., if the first query is "How did Alphabet - * do in 2022?" and the current query is "How about 2023?", the current query - * will be interpreted as "How did Alphabet do in 2023?". Example #2 - * (coordination between /search API calls and /answer API calls): Call /answer - * API with the session ID generated in the first call. Here, the answer - * generation happens in the context of the search results from the first - * search call. Multi-turn Search feature is currently at private GA stage. - * Please use v1alpha or v1beta version instead before we launch this feature - * to public GA. Or ask for allowlisting through Google Support team. - */ -@property(nonatomic, copy, nullable) NSString *session; +@end -/** Session specification. Can be used only when `session` is set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec *sessionSpec; /** - * The spell correction specification that specifies the mode under which spell - * correction takes effect. + * Response of the ImportDocumentsRequest. If the long running operation is + * done, then this message is returned by the + * google.longrunning.Operations.response field if the operation was + * successful. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec *spellCorrectionSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse : GTLRObject + +/** Echoes the destination for the complete errors in the request if set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +@end -/** - * Uses the Engine, ServingConfig and Control freshly read from the database. - * Note: this skips config cache and introduces dependency on databases, which - * could significantly increase the API latency. It should only be used for - * testing, but not serving end users. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *useLatestData; /** - * Information about the end user. Highly recommended for analytics and - * personalization. UserInfo.user_agent is used to deduce `device_type` for - * analytics. + * Configuration of destination for Import related errors. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserInfo *userInfo; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig : GTLRObject /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * Cloud Storage prefix for import errors. This must be an empty, existing + * Cloud Storage directory. Import errors are written to sharded files in this + * directory, one per line, as a JSON-encoded `google.rpc.Status` message. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_UserLabels *userLabels; +@property(nonatomic, copy, nullable) NSString *gcsPrefix; + +@end + /** - * A unique identifier for tracking visitors. For example, this could be - * implemented with an HTTP cookie, which should be able to uniquely identify a - * visitor on a single device. This unique identifier should not change if the - * visitor logs in or out of the website. This field should NOT have a fixed - * value such as `unknown_visitor`. This should be the same identifier as - * UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field - * must be a UTF-8 encoded string with a length limit of 128 characters. - * Otherwise, an `INVALID_ARGUMENT` error is returned. + * Response message for IdentityMappingStoreService.ImportIdentityMappings */ -@property(nonatomic, copy, nullable) NSString *userPseudoId; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; @end /** - * Additional search parameters. For public website search only, supported - * values are: * `user_country_code`: string. Default empty. If set to - * non-empty, results are restricted or boosted based on the location provided. - * For example, `user_country_code: "au"` For available codes see [Country - * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - * * `search_type`: double. Default empty. Enables non-webpage searching - * depending on the value. The only valid non-default value is 1, which enables - * image searching. For example, `search_type: 1` - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Metadata related to the progress of the ImportSampleQueries operation. This + * will be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_Params : GTLRObject -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata : GTLRObject +/** ImportSampleQueries operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * Count of SampleQuerys that failed to be imported. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_UserLabels : GTLRObject -@end +@property(nonatomic, strong, nullable) NSNumber *failureCount; +/** + * Count of SampleQuerys successfully imported. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Boost specification to boost certain documents. + * Total count of SampleQuerys that were processed. + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *totalCount; /** - * Condition boost specifications. If a document matches multiple conditions in - * the specifications, boost scores from these specifications are all applied - * and combined in a non-linear way. Maximum number of specifications is 20. + * ImportSampleQueries operation last update time. If the operation is done, + * this is also the finish time. */ -@property(nonatomic, strong, nullable) NSArray *conditionBoostSpecs; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Boost applies to documents which match a condition. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec : GTLRObject - -/** - * Strength of the condition boost, which should be in [-1, 1]. Negative boost - * means demotion. Default is 0.0. Setting to 1.0 gives the document a big - * promotion. However, it does not necessarily mean that the boosted document - * will be the top result at all times, nor that other documents will be - * excluded. Results could still be shown even when none of them matches the - * condition. And results that are significantly more relevant to the search - * query can still trump your heavily favored but irrelevant documents. Setting - * to -1.0 gives the document a big demotion. However, results that are deeply - * relevant might still be shown. The document will have an upstream battle to - * get a fairly high ranking, but it is not blocked out completely. Setting to - * 0.0 means no boost applied. The boosting condition is ignored. Only one of - * the (condition, boost) combination or the boost_control_spec below are set. - * If both are set then the global boost is ignored and the more fine-grained - * boost_control_spec is applied. - * - * Uses NSNumber of floatValue. + * Response of the SampleQueryService.ImportSampleQueries method. If the long + * running operation is done, this message is returned by the + * google.longrunning.Operations.response field if the operation is successful. */ -@property(nonatomic, strong, nullable) NSNumber *boost; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse : GTLRObject -/** - * Complex specification for custom ranking based on customer defined attribute - * value. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec *boostControlSpec; +/** The desired location of errors incurred during the Import. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; -/** - * An expression which specifies a boost condition. The syntax and supported - * fields are the same as a filter expression. See SearchRequest.filter for - * detail syntax and limitations. Examples: * To boost documents with document - * ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: - * ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` - */ -@property(nonatomic, copy, nullable) NSString *condition; +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; @end /** - * Specification for custom ranking based on customer specified attribute - * value. It provides more controls for customized ranking than the simple - * (condition, boost) combination above. + * Metadata related to the progress of the ImportSuggestionDenyListEntries + * operation. This is returned by the google.longrunning.Operation.metadata + * field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The attribute type to be used to determine the boost amount. The attribute - * value can be derived from the field value of the specified field_name. In - * the case of numerical it is straightforward i.e. attribute_value = - * numerical_field_value. In the case of freshness however, attribute_value = - * (time.now() - datetime_field_value). - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_AttributeTypeUnspecified - * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Freshness - * For the freshness use case the attribute value will be the duration - * between the current time and the date in the datetime field specified. - * The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: - * "FRESHNESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Numerical - * The value of the numerical field will be used to dynamically update - * the boost amount. In this case, the attribute_value (the x value) of - * the control point will be the actual value of the numerical field for - * which the boost_amount is specified. (Value: "NUMERICAL") + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *attributeType; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * The control points used to define the curve. The monotonic function (defined - * through the interpolation_type above) passes through the control points - * listed here. + * Response message for CompletionService.ImportSuggestionDenyListEntries + * method. */ -@property(nonatomic, strong, nullable) NSArray *controlPoints; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * The name of the field whose value will be used to determine the boost - * amount. + * Count of deny list entries that failed to be imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *fieldName; +@property(nonatomic, strong, nullable) NSNumber *failedEntriesCount; /** - * The interpolation type to be applied to connect the control points listed - * below. + * Count of deny list entries successfully imported. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_InterpolationTypeUnspecified - * Interpolation type is unspecified. In this case, it defaults to - * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_Linear - * Piecewise linear interpolation will be applied. (Value: "LINEAR") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *interpolationType; +@property(nonatomic, strong, nullable) NSNumber *importedEntriesCount; @end /** - * The control points used to define the curve. The curve defined through these - * control points can only be monotonically increasing or decreasing(constant - * values are acceptable). + * Metadata related to the progress of the Import operation. This is returned + * by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Can be one of: 1. The numerical field value. 2. The duration spec for - * freshness: The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this is: - * `nDnM]`. + * Count of entries that encountered errors while processing. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *attributeValue; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * The value between -1 to 1 by which to boost the score if the attribute_value - * evaluates to the value specified above. + * Count of entries that were processed successfully. * - * Uses NSNumber of floatValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *boostAmount; +@property(nonatomic, strong, nullable) NSNumber *successCount; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * A specification for configuring the behavior of content search. + * Response of the ImportUserEventsRequest. If the long running operation was + * successful, then this message is returned by the + * google.longrunning.Operations.response field if the operation was + * successful. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse : GTLRObject /** - * Specifies the chunk spec to be returned from the search response. Only - * available if the SearchRequest.ContentSearchSpec.search_result_mode is set - * to CHUNKS + * Echoes the destination for the complete errors if this field was set in the + * request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec *chunkSpec; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; -/** - * If there is no extractive_content_spec provided, there will be no extractive - * answer in the search response. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec *extractiveContentSpec; +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * Specifies the search result mode. If unspecified, the search result mode - * defaults to `DOCUMENTS`. + * Count of user events imported with complete existing Documents. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec_SearchResultMode_Chunks - * Returns chunks in the search result. Only available if the - * DocumentProcessingConfig.chunking_config is specified. (Value: - * "CHUNKS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec_SearchResultMode_Documents - * Returns documents in the search result. (Value: "DOCUMENTS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec_SearchResultMode_SearchResultModeUnspecified - * Default value. (Value: "SEARCH_RESULT_MODE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *searchResultMode; - -/** - * If `snippetSpec` is not specified, snippets are not included in the search - * response. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec *snippetSpec; +@property(nonatomic, strong, nullable) NSNumber *joinedEventsCount; /** - * If `summarySpec` is not specified, summaries are not included in the search - * response. + * Count of user events imported, but with Document information not found in + * the existing Branch. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec *summarySpec; +@property(nonatomic, strong, nullable) NSNumber *unjoinedEventsCount; @end /** - * Specifies the chunk spec to be returned from the search response. Only - * available if the SearchRequest.ContentSearchSpec.search_result_mode is set - * to CHUNKS + * A floating point interval. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaInterval : GTLRObject /** - * The number of next chunks to be returned of the current chunk. The maximum - * allowed value is 3. If not specified, no next chunks will be returned. + * Exclusive upper bound. * - * Uses NSNumber of intValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *numNextChunks; +@property(nonatomic, strong, nullable) NSNumber *exclusiveMaximum; /** - * The number of previous chunks to be returned of the current chunk. The - * maximum allowed value is 3. If not specified, no previous chunks will be - * returned. + * Exclusive lower bound. * - * Uses NSNumber of intValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *numPreviousChunks; - -@end - +@property(nonatomic, strong, nullable) NSNumber *exclusiveMinimum; /** - * A specification for configuring the extractive content in a search response. + * Inclusive upper bound. + * + * Uses NSNumber of doubleValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *maximum; /** - * The maximum number of extractive answers returned in each search result. An - * extractive answer is a verbatim answer extracted from the original document, - * which provides a precise and contextually relevant answer to the search - * query. If the number of matching answers is less than the - * `max_extractive_answer_count`, return all of the answers. Otherwise, return - * the `max_extractive_answer_count`. At most five answers are returned for - * each SearchResult. + * Inclusive lower bound. * - * Uses NSNumber of intValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *maxExtractiveAnswerCount; +@property(nonatomic, strong, nullable) NSNumber *minimum; + +@end + /** - * The max number of extractive segments returned in each search result. Only - * applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED - * or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is - * a text segment extracted from the original document that is relevant to the - * search query, and, in general, more verbose than an extractive answer. The - * segment could then be used as input for LLMs to generate summaries and - * answers. If the number of matching segments is less than - * `max_extractive_segment_count`, return all of the segments. Otherwise, - * return the `max_extractive_segment_count`. - * - * Uses NSNumber of intValue. + * Language info for DataStore. */ -@property(nonatomic, strong, nullable) NSNumber *maxExtractiveSegmentCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLanguageInfo : GTLRObject /** - * Return at most `num_next_segments` segments after each selected segments. - * - * Uses NSNumber of intValue. + * Output only. Language part of normalized_language_code. E.g.: `en-US` -> + * `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. */ -@property(nonatomic, strong, nullable) NSNumber *numNextSegments; +@property(nonatomic, copy, nullable) NSString *language; + +/** The language code for the DataStore. */ +@property(nonatomic, copy, nullable) NSString *languageCode; /** - * Specifies whether to also include the adjacent from each selected segments. - * Return at most `num_previous_segments` segments before each selected - * segments. - * - * Uses NSNumber of intValue. + * Output only. This is the normalized form of language_code. E.g.: + * language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have + * normalized_language_code of `en-GB`. */ -@property(nonatomic, strong, nullable) NSNumber *numPreviousSegments; +@property(nonatomic, copy, nullable) NSString *normalizedLanguageCode; /** - * Specifies whether to return the confidence score from the extractive - * segments in each search result. This feature is available only for new or - * allowlisted data stores. To allowlist your data store, contact your Customer - * Engineer. The default value is `false`. - * - * Uses NSNumber of boolValue. + * Output only. Region part of normalized_language_code, if present. E.g.: + * `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. */ -@property(nonatomic, strong, nullable) NSNumber *returnExtractiveSegmentScore; +@property(nonatomic, copy, nullable) NSString *region; @end /** - * A specification for configuring snippets in a search response. + * Information about users' licenses. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig : GTLRObject + +/** Optional. The alert policy config for this license config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig *alertPolicyResourceConfig; /** - * [DEPRECATED] This field is deprecated. To control snippet return, use - * `return_snippet` field. For backwards compatibility, we will return snippet - * if max_snippet_count > 0. + * Optional. Whether the license config should be auto renewed when it reaches + * the end date. * - * Uses NSNumber of intValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *maxSnippetCount GTLR_DEPRECATED; +@property(nonatomic, strong, nullable) NSNumber *autoRenew; + +/** Optional. The planed end date. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *endDate; /** - * [DEPRECATED] This field is deprecated and will have no affect on the - * snippet. + * Optional. Whether the license config is for free trial. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *referenceOnly GTLR_DEPRECATED; +@property(nonatomic, strong, nullable) NSNumber *freeTrial; /** - * If `true`, then return snippet. If no snippet can be generated, we return - * "No snippet is available for this page." A `snippet_status` with `SUCCESS` - * or `NO_SNIPPET_AVAILABLE` will also be returned. + * Required. Number of licenses purchased. * - * Uses NSNumber of boolValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *returnSnippet; - -@end - +@property(nonatomic, strong, nullable) NSNumber *licenseCount; /** - * A specification for configuring a summary returned in a search response. + * Immutable. Identifier. The fully qualified resource name of the license + * config. Format: + * `projects/{project}/locations/{location}/licenseConfigs/{license_config}` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *name; + +/** Required. The start date. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *startDate; /** - * Specifies whether to filter out adversarial queries. The default value is - * `false`. Google employs search-query classification to detect adversarial - * queries. No summary is returned if the search query is classified as an - * adversarial query. For example, a user might ask a question regarding - * negative comments about the company or submit a query designed to generate - * unsafe, policy-violating output. If this field is set to `true`, we skip - * generating summaries for adversarial queries and return fallback messages - * instead. + * Output only. The state of the license config. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_Active + * The license config is effective and being used. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_Expired + * The license config has expired. (Value: "EXPIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_NotStarted + * The license config has not started yet, and its start date is in the + * future. (Value: "NOT_STARTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_State_StateUnspecified + * Default value. The license config does not exist. (Value: + * "STATE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *ignoreAdversarialQuery; +@property(nonatomic, copy, nullable) NSString *state; /** - * Optional. Specifies whether to filter out jail-breaking queries. The default - * value is `false`. Google employs search-query classification to detect - * jail-breaking queries. No summary is returned if the search query is - * classified as a jail-breaking query. A user might add instructions to the - * query to change the tone, style, language, content of the answer, or ask the - * model to act as a different entity, e.g. "Reply in the tone of a competing - * company's CEO". If this field is set to `true`, we skip generating summaries - * for jail-breaking queries and return fallback messages instead. + * Required. Subscription term. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth + * 1 month. (Value: "SUBSCRIPTION_TERM_ONE_MONTH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermOneYear + * 1 year. (Value: "SUBSCRIPTION_TERM_ONE_YEAR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears + * 3 years. (Value: "SUBSCRIPTION_TERM_THREE_YEARS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified + * Default value, do not use. (Value: "SUBSCRIPTION_TERM_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *ignoreJailBreakingQuery; +@property(nonatomic, copy, nullable) NSString *subscriptionTerm; /** - * Specifies whether to filter out queries that have low relevance. The default - * value is `false`. If this field is set to `false`, all search results are - * used regardless of relevance to generate answers. If set to `true`, only - * queries with high relevance search results will generate answers. + * Required. Subscription tier information for the license config. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness + * Agentspace Business tier. (Value: + * "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter + * Agentspace Starter tier. (Value: + * "SUBSCRIPTION_TIER_AGENTSPACE_STARTER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEdu + * EDU tier. (Value: "SUBSCRIPTION_TIER_EDU") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging + * EDU emerging market tier. (Value: "SUBSCRIPTION_TIER_EDU_EMERGING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduPro + * EDU Pro tier. (Value: "SUBSCRIPTION_TIER_EDU_PRO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging + * EDU Pro emerging market tier. (Value: + * "SUBSCRIPTION_TIER_EDU_PRO_EMERGING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierEnterprise + * Enterprise tier. (Value: "SUBSCRIPTION_TIER_ENTERPRISE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker + * Frontline worker tier. (Value: "SUBSCRIPTION_TIER_FRONTLINE_WORKER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm + * NotebookLM tier. NotebookLM is a subscription tier can only access + * NotebookLM features. (Value: "SUBSCRIPTION_TIER_NOTEBOOK_LM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierSearch + * Search tier. Search tier can access VAIS search features and + * NotebookLM features. (Value: "SUBSCRIPTION_TIER_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant + * Search + assistant tier. Search + assistant tier can access VAIS + * search features, NotebookLM features and assistant features. (Value: + * "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaLicenseConfig_SubscriptionTier_SubscriptionTierUnspecified + * Default value. (Value: "SUBSCRIPTION_TIER_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *subscriptionTier; + +@end + + +/** + * Request for ListSessions method. */ -@property(nonatomic, strong, nullable) NSNumber *ignoreLowRelevantContent; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaListSessionsRequest : GTLRObject /** - * Specifies whether to filter out queries that are not summary-seeking. The - * default value is `false`. Google employs search-query classification to - * detect summary-seeking queries. No summary is returned if the search query - * is classified as a non-summary seeking query. For example, `why is the sky - * blue` and `Who is the best soccer player in the world?` are summary-seeking - * queries, but `SFO airport` and `world cup 2026` are not. They are most - * likely navigational queries. If this field is set to `true`, we skip - * generating summaries for non-summary seeking queries and return fallback - * messages instead. - * - * Uses NSNumber of boolValue. + * A comma-separated list of fields to filter by, in EBNF grammar. The + * supported fields are: * `user_pseudo_id` * `state` * `display_name` * + * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: + * * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = + * true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > + * "1970-01-01T12:00:00Z"` */ -@property(nonatomic, strong, nullable) NSNumber *ignoreNonSummarySeekingQuery; +@property(nonatomic, copy, nullable) NSString *filter; /** - * Specifies whether to include citations in the summary. The default value is - * `false`. When this field is set to `true`, summaries include in-line - * citation numbers. Example summary including citations: BigQuery is Google - * Cloud's fully managed and completely serverless enterprise data warehouse - * [1]. BigQuery supports all data types, works across clouds, and has built-in - * machine learning and business intelligence, all within a unified platform - * [2, 3]. The citation numbers refer to the returned search results and are - * 1-indexed. For example, [1] means that the sentence is attributed to the - * first search result. [2, 3] means that the sentence is attributed to both - * the second and third search results. - * - * Uses NSNumber of boolValue. + * A comma-separated list of fields to order by, sorted in ascending order. Use + * "desc" after a field name for descending. Supported fields: * `update_time` + * * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` + * * `create_time` * `is_pinned desc,update_time desc`: list sessions by + * is_pinned first, then by update_time. */ -@property(nonatomic, strong, nullable) NSNumber *includeCitations; +@property(nonatomic, copy, nullable) NSString *orderBy; /** - * Language code for Summary. Use language tags defined by - * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an - * experimental feature. + * Maximum number of results to return. If unspecified, defaults to 50. Max + * allowed value is 1000. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +@property(nonatomic, strong, nullable) NSNumber *pageSize; /** - * If specified, the spec will be used to modify the prompt provided to the - * LLM. + * A page token, received from a previous `ListSessions` call. Provide this to + * retrieve the subsequent page. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec *modelPromptSpec; +@property(nonatomic, copy, nullable) NSString *pageToken; /** - * If specified, the spec will be used to modify the model specification - * provided to the LLM. + * Required. The data store resource name. Format: + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec *modelSpec; +@property(nonatomic, copy, nullable) NSString *parent; + +@end -/** Optional. Multimodal specification. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec *multimodalSpec; /** - * The number of top results to generate the summary from. If the number of - * results returned is less than `summaryResultCount`, the summary is generated - * from all of the results. At most 10 results for documents mode, or 50 for - * chunks mode, can be used to generate a summary. The chunks mode is used when - * SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + * Response for ListSessions method. * - * Uses NSNumber of intValue. + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "sessions" property. If returned as the result of a query, it + * should support automatic pagination (when @c shouldFetchNextPages is + * enabled). */ -@property(nonatomic, strong, nullable) NSNumber *summaryResultCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaListSessionsResponse : GTLRCollectionObject + +/** Pagination token, if not returned indicates the last page. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; /** - * If true, answer will be generated from most relevant chunks from top search - * results. This feature will improve summary quality. Note that with this - * feature enabled, not all top search results will be referenced and included - * in the reference list, so the citation source index only points to the - * search results listed in the reference list. + * All the Sessions for a given data store. * - * Uses NSNumber of boolValue. + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSNumber *useSemanticChunks; +@property(nonatomic, strong, nullable) NSArray *sessions; @end /** - * Specification of the prompt to use with the model. + * Configuration for Natural Language Query Understanding. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig : GTLRObject /** - * Text at the beginning of the prompt that instructs the assistant. Examples - * are available in the user guide. + * Mode of Natural Language Query Understanding. If this field is unset, the + * behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_Disabled + * Natural Language Query Understanding is disabled. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_Enabled + * Natural Language Query Understanding is enabled. (Value: "ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig_Mode_ModeUnspecified + * Default value. (Value: "MODE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *preamble; +@property(nonatomic, copy, nullable) NSString *mode; @end /** - * Specification of the model. + * Response message for CrawlRateManagementService.ObtainCrawlRate method. The + * response contains organcic or dedicated crawl rate time series data for + * monitoring, depending on whether dedicated crawl rate is set. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse : GTLRObject /** - * The model version used to generate the summary. Supported values are: * - * `stable`: string. Default value when no value is specified. Uses a generally - * available, fine-tuned model. For more information, see [Answer generation - * model versions and - * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). - * * `preview`: string. (Public preview) Uses a preview model. For more - * information, see [Answer generation model versions and - * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * The historical dedicated crawl rate timeseries data, used for monitoring. */ -@property(nonatomic, copy, nullable) NSString *version; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries *dedicatedCrawlRateTimeSeries; -@end +/** Errors from service when handling the request. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +/** The historical organic crawl rate timeseries data, used for monitoring. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries *organicCrawlRateTimeSeries; /** - * Multimodal specification: Will return an image from specified source. If - * multiple sources are specified, the pick is a quality based decision. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec : GTLRObject - -/** - * Optional. Source of image returned in the answer. + * Output only. The state of the response. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_AllAvailableSources - * Behavior when service determines the pick from all available sources. - * (Value: "ALL_AVAILABLE_SOURCES") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_CorpusImageOnly - * Includes image from corpus in the answer. (Value: "CORPUS_IMAGE_ONLY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_FigureGenerationOnly - * Triggers figure generation in the answer. (Value: - * "FIGURE_GENERATION_ONLY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_ImageSourceUnspecified - * Unspecified image source (multimodal feature is disabled by default). - * (Value: "IMAGE_SOURCE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse_State_Failed + * The state is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse_State_StateUnspecified + * The state is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse_State_Succeeded + * The state is successful. (Value: "SUCCEEDED") */ -@property(nonatomic, copy, nullable) NSString *imageSource; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * A struct to define data stores to filter on in a search call and - * configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error - * is returned. + * The historical organic crawl rate timeseries data, used for monitoring. + * Organic crawl is auto-determined by Google to crawl the user's website when + * dedicate crawl is not set. Crawl rate is the QPS of crawl request Google + * sends to the user's website. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaOrganicCrawlRateTimeSeries : GTLRObject /** - * Optional. Boost specification to boost certain documents. For more - * information on boosting, see - * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + * Google's organic crawl rate time series, which is the sum of all googlebots' + * crawl rate. Please refer to + * https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers + * for more details about googlebots. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec *boostSpec; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *googleOrganicCrawlRate; /** - * Optional. Custom search operators which if specified will be used to filter - * results from workspace data stores. For more information on custom search - * operators, see - * [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + * Vertex AI's organic crawl rate time series, which is the crawl rate of + * Google-CloudVertexBot when dedicate crawl is not set. Please refer to + * https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot + * for more details about Google-CloudVertexBot. */ -@property(nonatomic, copy, nullable) NSString *customSearchOperators; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries *vertexAiOrganicCrawlRate; + +@end + /** - * Required. Full resource name of DataStore, such as - * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - * The path must include the project number, project id is not supported for - * this field. + * Metadata and configurations for a Google Cloud project in the service. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject : GTLRObject + +/** Output only. The timestamp when this project is created. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** Optional. Customer provided configurations. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig *customerProvidedConfig; /** - * Optional. Filter specification to filter documents in the data store - * specified by data_store field. For more information on filtering, see - * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * Output only. Full resource name of the project, for example + * `projects/{project}`. Note that when making requests, project number and + * project id are both acceptable, but the server will always respond in + * project number. */ -@property(nonatomic, copy, nullable) NSString *filter; - -@end +@property(nonatomic, copy, nullable) NSString *name; +/** + * Output only. The timestamp when this project is successfully provisioned. + * Empty value means this project is still provisioning and is not ready for + * use. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *provisionCompletionTime; /** - * Specifies features for display, like match highlighting. + * Output only. A map of terms of services. The key is the `id` of + * ServiceTerms. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject_ServiceTermsMap *serviceTermsMap; + +@end + /** - * The condition under which match highlighting should occur. + * Output only. A map of terms of services. The key is the `id` of + * ServiceTerms. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingConditionUnspecified - * Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. (Value: - * "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled - * Disables match highlighting on all documents. (Value: - * "MATCH_HIGHLIGHTING_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled - * Enables match highlighting on all documents. (Value: - * "MATCH_HIGHLIGHTING_ENABLED") + * @note This class is documented as having more properties of + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms. + * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get + * the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *matchHighlightingCondition; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProject_ServiceTermsMap : GTLRObject @end /** - * The specification that uses customized query embedding vector to do semantic - * document retrieval. + * Customer provided configurations. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig : GTLRObject -/** The embedding vector used for retrieval. Limit to 1. */ -@property(nonatomic, strong, nullable) NSArray *embeddingVectors; +/** Optional. Configuration for NotebookLM settings. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig *notebooklmConfig; @end /** - * Embedding vector. + * Configuration for NotebookLM. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector : GTLRObject - -/** Embedding field path in schema. */ -@property(nonatomic, copy, nullable) NSString *fieldPath; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig : GTLRObject /** - * Query embedding vector. - * - * Uses NSNumber of floatValue. + * Model Armor configuration to be used for sanitizing user prompts and LLM + * responses. */ -@property(nonatomic, strong, nullable) NSArray *vector; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig *modelArmorConfig; @end /** - * A facet specification to perform faceted search. + * Configuration for customer defined Model Armor templates to be used for + * sanitizing user prompts and LLM responses. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig : GTLRObject /** - * Enables dynamic position for this facet. If set to true, the position of - * this facet among all facets in the response is determined automatically. If - * dynamic facets are enabled, it is ordered together. If set to false, the - * position of this facet in the response is the same as in the request, and it - * is ranked before the facets with dynamic position enable and all dynamic - * facets. For example, you may always want to have rating facet returned in - * the response, but it's not necessarily to always display the rating facet at - * the top. In that case, you can set enable_dynamic_position to true so that - * the position of rating facet in response is determined automatically. - * Another example, assuming you have the following facets in the request: * - * "rating", enable_dynamic_position = true * "price", enable_dynamic_position - * = false * "brands", enable_dynamic_position = false And also you have a - * dynamic facets enabled, which generates a facet `gender`. Then the final - * order of the facets in the response can be ("price", "brands", "rating", - * "gender") or ("price", "brands", "gender", "rating") depends on how API - * orders "gender" and "rating" facets. However, notice that "price" and - * "brands" are always ranked at first and second position because their - * enable_dynamic_position is false. - * - * Uses NSNumber of boolValue. + * Optional. The resource name of the Model Armor Template for sanitizing LLM + * responses. Format: + * projects/{project}/locations/{location}/templates/{template_id} If not + * specified, no sanitization will be applied to the LLM response. */ -@property(nonatomic, strong, nullable) NSNumber *enableDynamicPosition; +@property(nonatomic, copy, nullable) NSString *responseTemplate; /** - * List of keys to exclude when faceting. By default, FacetKey.key is not - * excluded from the filter unless it is listed in this field. Listing a facet - * key in this field allows its values to appear as facet results, even when - * they are filtered out of search results. Using this field does not affect - * what search results are returned. For example, suppose there are 100 - * documents with the color facet "Red" and 200 documents with the color facet - * "Blue". A query containing the filter "color:ANY("Red")" and having "color" - * as FacetKey.key would by default return only "Red" documents in the search - * results, and also return "Red" with count 100 as the only color facet. - * Although there are also blue documents available, "Blue" would not be shown - * as an available facet value. If "color" is listed in "excludedFilterKeys", - * then the query returns the facet values "Red" with count 100 and "Blue" with - * count 200, because the "color" key is now excluded from the filter. Because - * this field doesn't affect search results, the search results are still - * correctly filtered to return only "Red" documents. A maximum of 100 values - * are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. The resource name of the Model Armor Template for sanitizing user + * prompts. Format: + * projects/{project}/locations/{location}/templates/{template_id} If not + * specified, no sanitization will be applied to the user prompt. */ -@property(nonatomic, strong, nullable) NSArray *excludedFilterKeys; +@property(nonatomic, copy, nullable) NSString *userPromptTemplate; + +@end -/** Required. The facet key specification. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey *facetKey; /** - * Maximum facet values that are returned for this facet. If unspecified, - * defaults to 20. The maximum allowed value is 300. Values above 300 are - * coerced to 300. For aggregation in healthcare search, when the - * [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden - * to 10,000 internally, regardless of the value set here. If this field is - * negative, an `INVALID_ARGUMENT` is returned. - * - * Uses NSNumber of intValue. + * Metadata about the terms of service. */ -@property(nonatomic, strong, nullable) NSNumber *limit; - -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms : GTLRObject +/** The last time when the project agreed to the terms of service. */ +@property(nonatomic, strong, nullable) GTLRDateTime *acceptTime; /** - * Specifies how a facet is computed. + * The last time when the project declined or revoked the agreement to terms of + * service. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey : GTLRObject +@property(nonatomic, strong, nullable) GTLRDateTime *declineTime; /** - * True to make facet keys case insensitive when getting faceting values with - * prefixes or contains; false otherwise. + * The unique identifier of this terms of service. Available terms: * + * `GA_DATA_USE_TERMS`: [Terms for data + * use](https://cloud.google.com/retail/data-use-terms). When using this as + * `id`, the acceptable version to provide is `2022-11-23`. * - * Uses NSNumber of boolValue. + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). */ -@property(nonatomic, strong, nullable) NSNumber *caseInsensitive; +@property(nonatomic, copy, nullable) NSString *identifier; /** - * Only get facet values that contain the given strings. For example, suppose - * "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > - * 2022". If set "contains" to "2022", the "category" facet only contains - * "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. - * Maximum is 10. + * Whether the project has accepted/rejected the service terms or it is still + * pending. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_StateUnspecified + * The default value of the enum. This value is not actually used. + * (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_TermsAccepted + * The project has given consent to the terms of service. (Value: + * "TERMS_ACCEPTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_TermsDeclined + * The project has declined or revoked the agreement to terms of service. + * (Value: "TERMS_DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProjectServiceTerms_State_TermsPending + * The project is pending to review and accept the terms of service. + * (Value: "TERMS_PENDING") */ -@property(nonatomic, strong, nullable) NSArray *contains; +@property(nonatomic, copy, nullable) NSString *state; /** - * Set only if values should be bucketed into intervals. Must be set for facets - * with numerical values. Must not be set for facet with text values. Maximum - * number of intervals is 30. + * The version string of the terms of service. For acceptable values, see the + * comments for id above. */ -@property(nonatomic, strong, nullable) NSArray *intervals; +@property(nonatomic, copy, nullable) NSString *version; + +@end -/** - * Required. Supported textual and numerical facet keys in Document object, - * over which the facet values are computed. Facet key is case-sensitive. - */ -@property(nonatomic, copy, nullable) NSString *key; /** - * The order in which documents are returned. Allowed values are: * "count - * desc", which means order by SearchResponse.Facet.values.count descending. * - * "value desc", which means order by SearchResponse.Facet.values.value - * descending. Only applies to textual facets. If not set, textual values are - * sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); - * numerical intervals are sorted in the order given by - * FacetSpec.FacetKey.intervals. + * Metadata associated with a project provision operation. */ -@property(nonatomic, copy, nullable) NSString *orderBy; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata : GTLRObject +@end + /** - * Only get facet values that start with the given string prefix. For example, - * suppose "category" has three values "Action > 2022", "Action > 2021" and - * "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only - * contains "Action > 2022" and "Action > 2021". Only supported on textual - * fields. Maximum is 10. + * Metadata related to the progress of the PurgeCompletionSuggestions + * operation. This is returned by the google.longrunning.Operation.metadata + * field. */ -@property(nonatomic, strong, nullable) NSArray *prefixes; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Only get facet for the given restricted values. Only supported on textual - * fields. For example, suppose "category" has three values "Action > 2022", - * "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > - * 2022", the "category" facet only contains "Action > 2022". Only supported on - * textual fields. Maximum is 10. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSArray *restrictedValues; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Specifies the image query input. + * Response message for CompletionService.PurgeCompletionSuggestions method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. + * Whether the completion suggestions were successfully purged. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *imageBytes; +@property(nonatomic, strong, nullable) NSNumber *purgeSucceeded; @end /** - * Specification to enable natural language understanding capabilities for - * search requests. + * Metadata related to the progress of the PurgeDocuments operation. This will + * be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. Controls behavior of how extracted filters are applied to the - * search. The default behavior depends on the request. For single datastore - * structured search, the default is `HARD_FILTER`. For multi-datastore search, - * the default behavior is `SOFT_BOOST`. Location-based filters are always - * applied as hard filters, and the `SOFT_BOOST` setting will not affect them. - * This field is only used if - * SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition - * is set to FilterExtractionCondition.ENABLED. + * Count of entries that encountered errors while processing. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified - * `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior - * for extracted filters. For single datastore search, the default is to - * apply as hard filters. For multi-datastore search, the default is to - * apply as soft boosts. (Value: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter - * Applies all extracted filters as hard filters on the results. Results - * that do not pass the extracted filters will not be returned in the - * result set. (Value: "HARD_FILTER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost - * Applies all extracted filters as soft boosts. Results that pass the - * filters will be boosted up to higher ranks in the result set. (Value: - * "SOFT_BOOST") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *extractedFilterBehavior; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * The condition under which filter extraction should occur. Server behavior - * defaults to `DISABLED`. + * Count of entries that were ignored as entries were not found. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified - * Server behavior defaults to `DISABLED`. (Value: - * "CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled - * Disables NL filter extraction. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled - * Enables NL filter extraction. (Value: "ENABLED") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *filterExtractionCondition; +@property(nonatomic, strong, nullable) NSNumber *ignoredCount; /** - * Field names used for location-based filtering, where geolocation filters are - * detected in natural language search queries. Only valid when the - * FilterExtractionCondition is set to `ENABLED`. If this field is set, it - * overrides the field names set in - * ServingConfig.geo_search_query_detection_field_names. + * Count of entries that were deleted successfully. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *geoSearchQueryDetectionFieldNames; +@property(nonatomic, strong, nullable) NSNumber *successCount; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * The specification for personalization. + * Response message for DocumentService.PurgeDocuments method. If the long + * running operation is successfully done, then this message is returned by the + * google.longrunning.Operations.response field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse : GTLRObject /** - * The personalization mode of the search request. Defaults to Mode.AUTO. + * The total count of documents purged as a result of the operation. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec_Mode_Auto - * Personalization is enabled if data quality requirements are met. - * (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec_Mode_Disabled - * Disable personalization. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec_Mode_ModeUnspecified - * Default value. In this case, server behavior defaults to Mode.AUTO. - * (Value: "MODE_UNSPECIFIED") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *mode; +@property(nonatomic, strong, nullable) NSNumber *purgeCount; + +/** + * A sample of document names that will be deleted. Only populated if `force` + * is set to false. A max of 100 names will be returned and the names are + * chosen at random. + */ +@property(nonatomic, strong, nullable) NSArray *purgeSample; @end /** - * Specification to determine under which conditions query expansion should - * occur. + * Metadata related to the progress of the PurgeSuggestionDenyListEntries + * operation. This is returned by the google.longrunning.Operation.metadata + * field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata : GTLRObject -/** - * The condition under which query expansion should occur. Default to - * Condition.DISABLED. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec_Condition_Auto - * Automatic query expansion built by the Search API. (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec_Condition_ConditionUnspecified - * Unspecified query expansion condition. In this case, server behavior - * defaults to Condition.DISABLED. (Value: "CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec_Condition_Disabled - * Disabled query expansion. Only the exact search query is used, even if - * SearchResponse.total_size is zero. (Value: "DISABLED") - */ -@property(nonatomic, copy, nullable) NSString *condition; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Whether to pin unexpanded results. If this field is set to true, unexpanded - * products are always at the top of the search results, followed by the - * expanded results. - * - * Uses NSNumber of boolValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *pinUnexpandedResults; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * The specification for returning the document relevance score. + * Response message for CompletionService.PurgeSuggestionDenyListEntries + * method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * Optional. Whether to return the relevance score for search results. The - * higher the score, the more relevant the document is to the query. + * Number of suggestion deny list entries purged. * - * Uses NSNumber of boolValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *returnRelevanceScore; +@property(nonatomic, strong, nullable) NSNumber *purgeCount; @end /** - * Specification for search as you type in search requests. + * Metadata related to the progress of the PurgeUserEvents operation. This will + * be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The condition under which search as you type should occur. Default to - * Condition.DISABLED. + * Count of entries that encountered errors while processing. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_Auto - * Automatic switching between search-as-you-type and standard search - * modes, ideal for single-API implementations (e.g., debouncing). - * (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_ConditionUnspecified - * Server behavior defaults to Condition.DISABLED. (Value: - * "CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_Disabled - * Disables Search As You Type. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_Enabled - * Enables Search As You Type. (Value: "ENABLED") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *condition; - -@end +@property(nonatomic, strong, nullable) NSNumber *failureCount; +/** + * Count of entries that were deleted successfully. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Session specification. Multi-turn Search feature is currently at private GA - * stage. Please use v1alpha or v1beta version instead before we launch this - * feature to public GA. Or ask for allowlisting through Google Support team. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec : GTLRObject +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * If set, the search result gets stored to the "turn" specified by this query - * ID. Example: Let's say the session looks like this: session { name: - * ".../sessions/xxx" turns { query { text: "What is foo?" query_id: - * ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How - * about bar then?" query_id: ".../questions/zzz" } } } The user can call - * /search API with a request like this: session: ".../sessions/xxx" - * session_spec { query_id: ".../questions/zzz" } Then, the API stores the - * search result, associated with the last turn. The stored search result can - * be used by a subsequent /answer API call (with the session ID and the query - * ID specified). Also, it is possible to call /search and /answer in parallel - * with the same session ID & query ID. + * Response of the PurgeUserEventsRequest. If the long running operation is + * successfully done, then this message is returned by the + * google.longrunning.Operations.response field. */ -@property(nonatomic, copy, nullable) NSString *queryId; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse : GTLRObject /** - * The number of top search results to persist. The persisted search results - * can be used for the subsequent /answer api call. This field is similar to - * the `summary_result_count` field in - * SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 - * results for documents mode, or 50 for chunks mode. + * The total count of events purged as a result of the operation. * - * Uses NSNumber of intValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *searchResultPersistenceCount; +@property(nonatomic, strong, nullable) NSNumber *purgeCount; @end /** - * The specification for query spell correction. + * Describes the metrics produced by the evaluation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetrics : GTLRObject /** - * The mode under which spell correction replaces the original search query. - * Defaults to Mode.AUTO. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec_Mode_Auto - * Automatic spell correction built by the Search API. Search will be - * based on the corrected query if found. (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec_Mode_ModeUnspecified - * Unspecified spell correction mode. In this case, server behavior - * defaults to Mode.AUTO. (Value: "MODE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec_Mode_SuggestionOnly - * Search API tries to find a spelling suggestion. If a suggestion is - * found, it is put in the SearchResponse.corrected_query. The spelling - * suggestion won't be used as the search query. (Value: - * "SUGGESTION_ONLY") - */ -@property(nonatomic, copy, nullable) NSString *mode; - -@end - - -/** - * External session proto definition. + * Normalized discounted cumulative gain (NDCG) per document, at various top-k + * cutoff levels. NDCG measures the ranking quality, giving higher relevance to + * top results. Example (top-3): Suppose SampleQuery with three retrieved + * documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 + * for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 + * (1), D3 (0)] Calculate NDCG\@3 for each SampleQuery: * DCG\@3: 0/log2(1+1) + + * 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + + * 0/log2(3+1) = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *docNdcg; /** - * Optional. The display name of the session. This field is used to identify - * the session in the UI. By default, the display name is the first turn query - * text in the session. + * Precision per document, at various top-k cutoff levels. Precision is the + * fraction of retrieved documents that are relevant. Example (top-5): * For a + * single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are + * relevant, precision\@5 = 4/5 = 0.8 */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Output only. The time the session finished. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *docPrecision; /** - * Optional. Whether the session is pinned, pinned session will be displayed on - * the top of the session list. - * - * Uses NSNumber of boolValue. + * Recall per document, at various top-k cutoff levels. Recall is the fraction + * of relevant documents retrieved out of all relevant documents. Example + * (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are + * retrieved in the top-5, recall\@5 = 3/5 = 0.6 */ -@property(nonatomic, strong, nullable) NSNumber *isPinned; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *docRecall; /** - * Immutable. Fully qualified name - * `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/ - * *` + * Normalized discounted cumulative gain (NDCG) per page, at various top-k + * cutoff levels. NDCG measures the ranking quality, giving higher relevance to + * top results. Example (top-3): Suppose SampleQuery with three retrieved pages + * (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not + * relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 + * (0)] Calculate NDCG\@3 for SampleQuery: * DCG\@3: 0/log2(1+1) + 1/log2(2+1) + * + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) + * = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Output only. The time the session started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *pageNdcg; /** - * The state of the session. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession_State_InProgress - * The session is currently open. (Value: "IN_PROGRESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession_State_StateUnspecified - * State is unspecified. (Value: "STATE_UNSPECIFIED") + * Recall per page, at various top-k cutoff levels. Recall is the fraction of + * relevant pages retrieved out of all relevant pages. Example (top-5): * For a + * single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, + * recall\@5 = 3/5 = 0.6 */ -@property(nonatomic, copy, nullable) NSString *state; - -/** Turns. */ -@property(nonatomic, strong, nullable) NSArray *turns; - -/** A unique identifier for tracking users. */ -@property(nonatomic, copy, nullable) NSString *userPseudoId; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics *pageRecall; @end /** - * Represents a turn, including a query from the user and a answer from - * service. + * Stores the metric values at specific top-k levels. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics : GTLRObject /** - * Optional. The resource name of the answer to the user query. Only set if the - * answer generation (/answer API call) happened in this turn. + * The top-1 value. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, copy, nullable) NSString *answer; +@property(nonatomic, strong, nullable) NSNumber *top1; /** - * Output only. In ConversationalSearchService.GetSession API, if - * GetSessionRequest.include_answer_details is set to true, this field will be - * populated when getting answer query session. + * The top-10 value. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer *detailedAnswer; +@property(nonatomic, strong, nullable) NSNumber *top10; /** - * Optional. The user query. May not be set if this turn is merely regenerating - * an answer to a different turn + * The top-3 value. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQuery *query; +@property(nonatomic, strong, nullable) NSNumber *top3; /** - * Optional. Represents metadata related to the query config, for example LLM - * model and version used, model parameters (temperature, grounding parameters, - * etc.). The prefix "google." is reserved for Google-developed functionality. + * The top-5 value. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn_QueryConfig *queryConfig; +@property(nonatomic, strong, nullable) NSNumber *top5; @end /** - * Optional. Represents metadata related to the query config, for example LLM - * model and version used, model parameters (temperature, grounding parameters, - * etc.). The prefix "google." is reserved for Google-developed functionality. - * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Defines a user inputed query. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn_QueryConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQuery : GTLRObject + +/** Output only. Unique Id for the query. */ +@property(nonatomic, copy, nullable) NSString *queryId; + +/** Plain text. */ +@property(nonatomic, copy, nullable) NSString *text; + @end /** - * Metadata related to the progress of the - * CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.RecrawlUris + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Unique URIs in the request that have invalid format. Sample limited to 1000. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) NSArray *invalidUris; /** - * Response message for CrawlRateManagementService.SetDedicatedCrawlRate - * method. It simply returns the state of the response, and an error message if - * the state is FAILED. + * Total number of unique URIs in the request that have invalid format. + * + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *invalidUrisCount; -/** Errors from service when handling the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +/** URIs that have no index meta tag. Sample limited to 1000. */ +@property(nonatomic, strong, nullable) NSArray *noindexUris; /** - * Output only. The state of the response. + * Total number of URIs that have no index meta tag. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse_State_Failed - * The state is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse_State_StateUnspecified - * The state is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse_State_Succeeded - * The state is successful. (Value: "SUCCEEDED") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *state; - -@end - +@property(nonatomic, strong, nullable) NSNumber *noindexUrisCount; /** - * Metadata for DataConnectorService.SetUpDataConnector method. + * Total number of URIs that have yet to be crawled. + * + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata : GTLRObject -@end - +@property(nonatomic, strong, nullable) NSNumber *pendingCount; /** - * Metadata related to the progress of the - * SiteSearchEngineService.SetUriPatternDocumentData operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Total number of URIs that were rejected due to insufficient indexing + * resources. + * + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *quotaExceededCount; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Total number of URIs that have been crawled so far. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *successCount; /** * Operation last update time. If the operation is done, this is also the @@ -15240,453 +15423,2377 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe */ @property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -@end - - /** - * Response message for SiteSearchEngineService.SetUriPatternDocumentData - * method. + * Unique URIs in the request that don't match any TargetSite in the DataStore, + * only match TargetSites that haven't been fully indexed, or match a + * TargetSite with type EXCLUDE. Sample limited to 1000. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse : GTLRObject -@end - +@property(nonatomic, strong, nullable) NSArray *urisNotMatchingTargetSites; /** - * Metadata for single-regional CMEKs. + * Total number of URIs that don't match any TargetSites. + * + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSingleRegionKey : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *urisNotMatchingTargetSitesCount; /** - * Required. Single-regional kms key resource name which will be used to - * encrypt resources - * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + * Total number of unique URIs in the request that are not in invalid_uris. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *kmsKey; +@property(nonatomic, strong, nullable) NSNumber *validUrisCount; @end /** - * A sitemap for the SiteSearchEngine. + * Response message for SiteSearchEngineService.RecrawlUris method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSitemap : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse : GTLRObject + +/** URIs that were not crawled before the LRO terminated. */ +@property(nonatomic, strong, nullable) NSArray *failedUris; + +/** Details for a sample of up to 10 `failed_uris`. */ +@property(nonatomic, strong, nullable) NSArray *failureSamples; + +@end -/** Output only. The sitemap's creation time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Output only. The fully qualified resource name of the sitemap. `projects/ * - * /locations/ * /collections/ * /dataStores/ * /siteSearchEngine/sitemaps/ *` - * The `sitemap_id` suffix is system-generated. + * Details about why a particular URI failed to be crawled. Each FailureInfo + * contains one FailureReason per CorpusType. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo : GTLRObject -/** Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. */ +/** List of failure reasons by corpus type (e.g. desktop, mobile). */ +@property(nonatomic, strong, nullable) NSArray *failureReasons; + +/** URI that failed to be crawled. */ @property(nonatomic, copy, nullable) NSString *uri; @end /** - * Verification information for target sites in advanced site search. + * Details about why crawling failed for a particular CorpusType, e.g., DESKTOP + * and MOBILE crawling may fail for different reasons. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason : GTLRObject /** - * Site verification state indicating the ownership and validity. + * DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_Exempted - * Site exempt from verification, e.g., a public website that opens to - * all. (Value: "EXEMPTED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_SiteVerificationStateUnspecified - * Defaults to VERIFIED. (Value: "SITE_VERIFICATION_STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_Unverified - * Site ownership pending verification or verification failed. (Value: - * "UNVERIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_Verified - * Site ownership verified. (Value: "VERIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason_CorpusType_CorpusTypeUnspecified + * Default value. (Value: "CORPUS_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason_CorpusType_Desktop + * Denotes a crawling attempt for the desktop version of a page. (Value: + * "DESKTOP") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason_CorpusType_Mobile + * Denotes a crawling attempt for the mobile version of a page. (Value: + * "MOBILE") */ -@property(nonatomic, copy, nullable) NSString *siteVerificationState; +@property(nonatomic, copy, nullable) NSString *corpusType; -/** Latest site verification time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *verifyTime; +/** Reason why the URI was not crawled. */ +@property(nonatomic, copy, nullable) NSString *errorMessage; @end /** - * A target site for the SiteSearchEngine. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite : GTLRObject - -/** - * Immutable. If set to false, a uri_pattern is generated to include all pages - * whose address contains the provided_uri_pattern. If set to true, an - * uri_pattern is generated to try to be an exact match of the - * provided_uri_pattern or just the specific page if the provided_uri_pattern - * is a specific one. provided_uri_pattern is always normalized to generate the - * URI pattern to be used by the search engine. - * - * Uses NSNumber of boolValue. + * Metadata related to the progress of the + * CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) NSNumber *exactMatch; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata : GTLRObject -/** Output only. Failure reason. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason *failureReason; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *generatedUriPattern; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** - * Output only. Indexing status. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Cancellable - * The target site change is pending but cancellable. (Value: - * "CANCELLABLE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Cancelled - * The target site change is cancelled. (Value: "CANCELLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Deleting - * The previously indexed target site has been marked to be deleted. This - * is a transitioning state which will resulted in either: 1. target site - * deleted if unindexing is successful; 2. state reverts to SUCCEEDED if - * the unindexing fails. (Value: "DELETING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Failed - * The target site fails to be indexed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_IndexingStatusUnspecified - * Defaults to SUCCEEDED. (Value: "INDEXING_STATUS_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Pending - * The target site is in the update queue and will be picked up by - * indexing pipeline. (Value: "PENDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Succeeded - * The target site has been indexed. (Value: "SUCCEEDED") - */ -@property(nonatomic, copy, nullable) NSString *indexingStatus; +@end -/** - * Output only. The fully qualified resource name of the target site. - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - * The `target_site_id` is system-generated. - */ -@property(nonatomic, copy, nullable) NSString *name; /** - * Required. Input only. The user provided URI pattern from which the - * `generated_uri_pattern` is generated. + * Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate + * method. It simply returns the state of the response, and an error message if + * the state is FAILED. */ -@property(nonatomic, copy, nullable) NSString *providedUriPattern; - -/** Output only. Root domain of the provided_uri_pattern. */ -@property(nonatomic, copy, nullable) NSString *rootDomainUri; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse : GTLRObject -/** Output only. Site ownership and validity verification status. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo *siteVerificationInfo; +/** Errors from service when handling the request. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; /** - * The type of the target site, e.g., whether the site is to be included or - * excluded. + * Output only. The state of the response. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_Type_Exclude - * Exclude the target site. (Value: "EXCLUDE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_Type_Include - * Include the target site. (Value: "INCLUDE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_Type_TypeUnspecified - * This value is unused. In this case, server behavior defaults to - * Type.INCLUDE. (Value: "TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse_State_Failed + * The state is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse_State_StateUnspecified + * The state is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse_State_Succeeded + * The state is successful. (Value: "SUCCEEDED") */ -@property(nonatomic, copy, nullable) NSString *type; - -/** Output only. The target site's last updated time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Site search indexing failure reasons. + * Safety rating corresponding to the generated content. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason : GTLRObject - -/** Failed due to insufficient quota. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure *quotaFailure; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating : GTLRObject /** - * Failed due to insufficient quota. + * Output only. Indicates whether the content was filtered out because of this + * rating. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *blocked; /** - * This number is an estimation on how much total quota this project needs to - * successfully complete indexing. + * Output only. Harm category. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryCivicIntegrity + * The harm category is civic integrity. (Value: + * "HARM_CATEGORY_CIVIC_INTEGRITY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryDangerousContent + * The harm category is dangerous content. (Value: + * "HARM_CATEGORY_DANGEROUS_CONTENT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryHarassment + * The harm category is harassment. (Value: "HARM_CATEGORY_HARASSMENT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryHateSpeech + * The harm category is hate speech. (Value: "HARM_CATEGORY_HATE_SPEECH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategorySexuallyExplicit + * The harm category is sexually explicit content. (Value: + * "HARM_CATEGORY_SEXUALLY_EXPLICIT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Category_HarmCategoryUnspecified + * The harm category is unspecified. (Value: "HARM_CATEGORY_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *totalRequiredQuota; - -@end - +@property(nonatomic, copy, nullable) NSString *category; /** - * Tenant information for a connector source. This includes some of the same - * information stored in the Credential message, but is limited to only what is - * needed to provide a list of accessible tenants to the user. + * Output only. Harm probability levels in the content. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_HarmProbabilityUnspecified + * Harm probability unspecified. (Value: "HARM_PROBABILITY_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_High + * High level of harm. (Value: "HIGH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_Low + * Low level of harm. (Value: "LOW") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_Medium + * Medium level of harm. (Value: "MEDIUM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Probability_Negligible + * Negligible level of harm. (Value: "NEGLIGIBLE") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTenant : GTLRObject +@property(nonatomic, copy, nullable) NSString *probability; -/** Optional display name for the tenant, e.g. "My Slack Team". */ -@property(nonatomic, copy, nullable) NSString *displayName; +/** + * Output only. Harm probability score. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *probabilityScore; /** - * The tenant's instance ID. Examples: Jira - * ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). + * Output only. Harm severity levels in the content. * - * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityHigh + * High level of harm severity. (Value: "HARM_SEVERITY_HIGH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityLow + * Low level of harm severity. (Value: "HARM_SEVERITY_LOW") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityMedium + * Medium level of harm severity. (Value: "HARM_SEVERITY_MEDIUM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityNegligible + * Negligible level of harm severity. (Value: "HARM_SEVERITY_NEGLIGIBLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSafetyRating_Severity_HarmSeverityUnspecified + * Harm severity unspecified. (Value: "HARM_SEVERITY_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *identifier; +@property(nonatomic, copy, nullable) NSString *severity; /** - * The URI of the tenant, if applicable. For example, the URI of a Jira - * instance is https://my-jira-instance.atlassian.net, and a Slack tenant does - * not have a URI. + * Output only. Harm severity score. + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, strong, nullable) NSNumber *severityScore; @end /** - * Metadata related to the progress of the TrainCustomModel operation. This is - * returned by the google.longrunning.Operation.metadata field. + * Defines the structure and layout of a type of document data. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Output only. Configurations for fields of the schema. */ +@property(nonatomic, strong, nullable) NSArray *fieldConfigs; + +/** The JSON representation of the schema. */ +@property(nonatomic, copy, nullable) NSString *jsonSchema; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Immutable. The full resource name of the schema, in the format of + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. + * This field must be a UTF-8 encoded string with a length limit of 1024 + * characters. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *name; + +/** The structured representation of the schema. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema_StructSchema *structSchema; @end /** - * Response of the TrainCustomModelRequest. This message is returned by the - * google.longrunning.Operations.response field. + * The structured representation of the schema. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse : GTLRObject - -/** Echoes the destination for the complete errors in the request if set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSchema_StructSchema : GTLRObject +@end -/** A sample of errors encountered while processing the data. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; - -/** The metrics of the trained model. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse_Metrics *metrics; - -/** Fully qualified name of the CustomTuningModel. */ -@property(nonatomic, copy, nullable) NSString *modelName; /** - * The trained model status. Possible values are: * **bad-data**: The training - * data quality is bad. * **no-improvement**: Tuning didn't improve - * performance. Won't deploy. * **in-progress**: Model training job creation is - * in progress. * **training**: Model is actively training. * **evaluating**: - * The model is evaluating trained metrics. * **indexing**: The model trained - * metrics are indexing. * **ready**: The model is ready for serving. + * Promotion proto includes uri and other helping information to display the + * promotion. */ -@property(nonatomic, copy, nullable) NSString *modelStatus; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion : GTLRObject /** - * The metrics of the trained model. + * Optional. The Promotion description. Maximum length: 200 characters. * - * @note This class is documented as having more properties of NSNumber (Uses - * NSNumber of doubleValue.). Use @c -additionalJSONKeys and @c - * -additionalPropertyForName: to get the list of properties and then - * fetch them; or @c -additionalProperties to fetch them all at once. + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse_Metrics : GTLRObject -@end - +@property(nonatomic, copy, nullable) NSString *descriptionProperty; /** - * Metadata associated with a tune operation. + * Optional. The Document the user wants to promote. For site search, leave + * unset and only populate uri. Can be set along with uri. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *document; /** - * Required. The resource name of the engine that this tune applies to. Format: - * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + * Optional. The enabled promotion will be returned for any serving configs + * associated with the parent of the control this promotion is attached to. + * This flag is used for basic site search only. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *engine; +@property(nonatomic, strong, nullable) NSNumber *enabled; -@end +/** Optional. The promotion thumbnail image url. */ +@property(nonatomic, copy, nullable) NSString *imageUri; +/** Required. The title of the promotion. Maximum length: 160 characters. */ +@property(nonatomic, copy, nullable) NSString *title; /** - * Response associated with a tune operation. + * Optional. The URL for the page the user wants to promote. Must be set for + * site search. For other verticals, this is optional. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTuneEngineResponse : GTLRObject +@property(nonatomic, copy, nullable) NSString *uri; + @end /** - * Metadata related to the progress of the CmekConfigService.UpdateCmekConfig - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Request message for SearchService.Search method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Boost specification to boost certain documents. For more information on + * boosting, see + * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec *boostSpec; /** - * Metadata related to the progress of the CollectionService.UpdateCollection - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * The branch resource name, such as `projects/ * + * /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. + * Use `default_branch` as the branch ID or leave this field empty, to search + * documents under the default branch. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, copy, nullable) NSString *branch; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The default filter that is applied when a user performs a search without + * checking any filters on the search page. The filter applied to every search + * request when quality improvement such as query expansion is needed. In the + * case a query does not have a sufficient amount of results this filter will + * be used to determine whether or not to enable the query expansion flow. The + * original filter will still be used for the query expanded search. This field + * is strongly recommended to achieve high search quality. For more information + * about filter syntax, see SearchRequest.filter. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, copy, nullable) NSString *canonicalFilter; +/** A specification for configuring the behavior of content search. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec *contentSearchSpec; /** - * Metadata for UpdateSchema LRO. + * Custom fine tuning configs. If set, it has higher priority than the configs + * set in ServingConfig.custom_fine_tuning_spec. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec *customFineTuningSpec; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Specifications that define the specific DataStores to be searched, along + * with configurations for those data stores. This is only considered for + * Engines with multiple data stores. For engines with a single data store, the + * specs directly under SearchRequest should be used. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) NSArray *dataStoreSpecs; /** - * Request for UpdateSession method. + * Optional. Config for display feature, like match highlighting on search + * results. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest : GTLRObject - -/** Required. The Session to update. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession *session; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec *displaySpec; /** - * Indicates which fields in the provided Session to update. The following are - * NOT supported: * Session.name If not set or empty, all supported fields are - * updated. - * - * String format is a comma-separated list of fields. + * Uses the provided embedding to do additional semantic document retrieval. + * The retrieval is based on the dot product of + * SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document + * embedding that is provided in + * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If + * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it + * will use ServingConfig.EmbeddingConfig.field_path. */ -@property(nonatomic, copy, nullable) NSString *updateMask; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec *embeddingSpec; /** - * Metadata related to the progress of the - * SiteSearchEngineService.UpdateTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Facet specifications for faceted search. If empty, no facets are returned. A + * maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is + * returned. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) NSArray *facetSpecs; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The filter syntax consists of an expression language for constructing a + * predicate from one or more fields of the documents being filtered. Filter + * expression is case-sensitive. If this field is unrecognizable, an + * `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by + * mapping the LHS filter key to a key property defined in the Vertex AI Search + * backend -- this mapping is defined by the customer in their schema. For + * example a media customer might have a field 'name' in their schema. In this + * case the filter would look like this: filter --> name:'ANY("king kong")' For + * more information about filtering including syntax and filter operators, see + * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, copy, nullable) NSString *filter; +/** Raw image query. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery *imageQuery; /** - * Information of an end user. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more + * information, see [Standard + * fields](https://cloud.google.com/apis/design/standard_fields). This field + * helps to better interpret the query. If a value isn't specified, the query + * language code is automatically detected, which may not be accurate. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserInfo : GTLRObject - -/** Optional. IANA time zone, e.g. Europe/Budapest. */ -@property(nonatomic, copy, nullable) NSString *timeZone; +@property(nonatomic, copy, nullable) NSString *languageCode; /** - * User agent as included in the HTTP header. The field must be a UTF-8 encoded - * string with a length limit of 1,000 characters. Otherwise, an - * `INVALID_ARGUMENT` error is returned. This should not be set when using the - * client side event reporting with GTM or JavaScript tag in - * UserEventService.CollectUserEvent or if UserEvent.direct_user_request is - * set. + * Optional. Config for natural language query understanding capabilities, such + * as extracting structured field filters from the query. Refer to [this + * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) + * for more information. If `naturalLanguageQueryUnderstandingSpec` is not + * specified, no additional natural language query understanding will be done. */ -@property(nonatomic, copy, nullable) NSString *userAgent; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec *naturalLanguageQueryUnderstandingSpec; /** - * Highly recommended for logged-in users. Unique identifier for logged-in - * user, such as a user name. Don't set for anonymous users. Always use a - * hashed value for this ID. Don't set the field to the same fixed ID for - * different users. This mixes the event history of those users together, which - * results in degraded model quality. The field must be a UTF-8 encoded string - * with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` - * error is returned. + * A 0-indexed integer that specifies the current offset (that is, starting + * result location, amongst the Documents deemed by the API as relevant) in + * search results. This field is only considered if page_token is unset. If + * this field is negative, an `INVALID_ARGUMENT` is returned. A large offset + * may be capped to a reasonable threshold. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *userId; - -@end +@property(nonatomic, strong, nullable) NSNumber *offset; +/** + * The maximum number of results to return for OneBox. This applies to each + * OneBox type individually. Default number is 10. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *oneBoxPageSize; /** - * User License information assigned by the admin. + * The order in which documents are returned. Documents can be ordered by a + * field in an Document object. Leave it unset if ordered by relevance. + * `order_by` expression is case-sensitive. For more information on ordering + * the website search results, see [Order web search + * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + * For more information on ordering the healthcare search results, see [Order + * healthcare search + * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserLicense : GTLRObject +@property(nonatomic, copy, nullable) NSString *orderBy; -/** Output only. User created timestamp. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Maximum number of Documents to return. The maximum allowed value depends on + * the data type. Values above the maximum value are coerced to the maximum + * value. * Websites with basic indexing: Default `10`, Maximum `25`. * + * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: + * Default `50`, Maximum `100`. If this field is negative, an + * `INVALID_ARGUMENT` is returned. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *pageSize; /** - * Output only. User last logged in time. If the user has not logged in yet, - * this field will be empty. + * A page token received from a previous SearchService.Search call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters + * provided to SearchService.Search must match the call that provided the page + * token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ -@property(nonatomic, strong, nullable) GTLRDateTime *lastLoginTime; +@property(nonatomic, copy, nullable) NSString *pageToken; /** - * Output only. License assignment state of the user. If the user is assigned - * with a license config, the user login will be assigned with the license; If - * the user's license assignment state is unassigned or unspecified, no license + * Additional search parameters. For public website search only, supported + * values are: * `user_country_code`: string. Default empty. If set to + * non-empty, results are restricted or boosted based on the location provided. + * For example, `user_country_code: "au"` For available codes see [Country + * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * * `search_type`: double. Default empty. Enables non-webpage searching + * depending on the value. The only valid non-default value is 1, which enables + * image searching. For example, `search_type: 1` + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_Params *params; + +/** + * The specification for personalization. Notice that if both + * ServingConfig.personalization_spec and SearchRequest.personalization_spec + * are set, SearchRequest.personalization_spec overrides + * ServingConfig.personalization_spec. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec *personalizationSpec; + +/** Raw search query. */ +@property(nonatomic, copy, nullable) NSString *query; + +/** + * The query expansion specification that specifies the conditions under which + * query expansion occurs. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec *queryExpansionSpec; + +/** + * Optional. The ranking expression controls the customized ranking on + * retrieval documents. This overrides ServingConfig.ranking_expression. The + * syntax and supported features depend on the `ranking_expression_backend` + * value. If `ranking_expression_backend` is not provided, it defaults to + * `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to + * `RANK_BY_EMBEDDING`, it should be a single function or multiple functions + * that are joined by "+". * ranking_expression = function, { " + ", function + * }; Supported functions: * double * relevance_score * double * + * dotProduct(embedding_field_path) Function variables: * `relevance_score`: + * pre-defined keywords, used for measure relevance between query and document. + * * `embedding_field_path`: the document embedding field used with query + * embedding vector. * `dotProduct`: embedding function between + * `embedding_field_path` and query embedding vector. Example ranking + * expression: If document has an embedding field doc_embedding, the ranking + * expression could be `0.5 * relevance_score + 0.3 * + * dotProduct(doc_embedding)`. If ranking_expression_backend is set to + * `RANK_BY_FORMULA`, the following expression types (and combinations of those + * chained using + or * operators) are supported: * `double` * `signal` * + * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank + * transformation with second argument being a denominator constant. * + * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * + * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 + * | double, else returns signal1. Here are a few examples of ranking formulas + * that use the supported ranking expression types: - `0.2 * + * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly + * rank by the logarithm of `keyword_similarity_score` with slight + * `semantic_smilarity_score` adjustment. - `0.2 * + * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * + * is_nan(keyword_similarity_score)` -- rank by the exponent of + * `semantic_similarity_score` filling the value with 0 if it's NaN, also add + * constant 0.3 adjustment to the final score if `semantic_similarity_score` is + * NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * + * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of + * `keyword_similarity_score` with slight adjustment of reciprocal rank of + * `semantic_smilarity_score`. The following signals are supported: * + * `semantic_similarity_score`: semantic similarity adjustment that is + * calculated using the embeddings generated by a proprietary Google model. + * This score determines how semantically similar a search query is to a + * document. * `keyword_similarity_score`: keyword match adjustment uses the + * Best Match 25 (BM25) ranking function. This score is calculated using a + * probabilistic model to estimate the probability that a document is relevant + * to a given query. * `relevance_score`: semantic relevance adjustment that + * uses a proprietary Google model to determine the meaning and intent behind a + * user's query in context with the content in the documents. * `pctr_rank`: + * predicted conversion rate adjustment as a rank use predicted Click-through + * rate (pCTR) to gauge the relevance and attractiveness of a search result + * from a user's perspective. A higher pCTR suggests that the result is more + * likely to satisfy the user's query and intent, making it a valuable signal + * for ranking. * `freshness_rank`: freshness adjustment as a rank * + * `document_age`: The time in hours elapsed since the document was last + * updated, a floating-point number (e.g., 0.25 means 15 minutes). * + * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google + * model to determine the keyword-based overlap between the query and the + * document. * `base_rank`: the default rank of the result + */ +@property(nonatomic, copy, nullable) NSString *rankingExpression; + +/** + * Optional. The backend to use for the ranking expression evaluation. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_Byoe + * Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom + * embedding model, the default way to evaluate the ranking expression. + * Legacy enum option, `RANK_BY_EMBEDDING` should be used instead. + * (Value: "BYOE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_Clearbox + * Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. + * Legacy enum option, `RANK_BY_FORMULA` should be used instead. (Value: + * "CLEARBOX") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_RankByEmbedding + * Ranking by custom embedding model, the default way to evaluate the + * ranking expression. (Value: "RANK_BY_EMBEDDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_RankByFormula + * Ranking by custom formula. (Value: "RANK_BY_FORMULA") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RankingExpressionBackend_RankingExpressionBackendUnspecified + * Default option for unspecified/unknown values. (Value: + * "RANKING_EXPRESSION_BACKEND_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *rankingExpressionBackend; + +/** + * The Unicode country/region code (CLDR) of a location, such as "US" and + * "419". For more information, see [Standard + * fields](https://cloud.google.com/apis/design/standard_fields). If set, then + * results will be boosted based on the region_code provided. + */ +@property(nonatomic, copy, nullable) NSString *regionCode; + +/** Optional. The specification for returning the relevance score. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec *relevanceScoreSpec; + +/** + * The relevance threshold of the search results. Default to Google defined + * threshold, leveraging a balance of precision and recall to deliver both + * highly accurate results and comprehensive coverage of relevant information. + * This feature is not supported for healthcare search. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_High + * High relevance threshold. (Value: "HIGH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_Low + * Low relevance threshold. (Value: "LOW") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_Lowest + * Lowest relevance threshold. (Value: "LOWEST") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_Medium + * Medium relevance threshold. (Value: "MEDIUM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_RelevanceThreshold_RelevanceThresholdUnspecified + * Default value. In this case, server behavior defaults to Google + * defined threshold. (Value: "RELEVANCE_THRESHOLD_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *relevanceThreshold; + +/** + * Whether to turn on safe search. This is only supported for website search. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *safeSearch; + +/** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new + * repricing model. This field is only supported for search requests. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec *searchAddonSpec; + +/** + * Search as you type configuration. Only supported for the + * IndustryVertical.MEDIA vertical. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec *searchAsYouTypeSpec; + +/** + * Required. The resource name of the Search serving config, such as `projects/ + * * /locations/global/collections/default_collection/engines/ * + * /servingConfigs/default_serving_config`, or `projects/ * + * /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. + * This field is used to identify the serving configuration name, set of models + * used to make the search. + */ +@property(nonatomic, copy, nullable) NSString *servingConfig; + +/** + * The session resource name. Optional. Session allows users to do multi-turn + * /search API calls or coordination between /search API calls and /answer API + * calls. Example #1 (multi-turn /search API calls): Call /search API with the + * session ID generated in the first call. Here, the previous search query gets + * considered in query standing. I.e., if the first query is "How did Alphabet + * do in 2022?" and the current query is "How about 2023?", the current query + * will be interpreted as "How did Alphabet do in 2023?". Example #2 + * (coordination between /search API calls and /answer API calls): Call /answer + * API with the session ID generated in the first call. Here, the answer + * generation happens in the context of the search results from the first + * search call. Multi-turn Search feature is currently at private GA stage. + * Please use v1alpha or v1beta version instead before we launch this feature + * to public GA. Or ask for allowlisting through Google Support team. + */ +@property(nonatomic, copy, nullable) NSString *session; + +/** Session specification. Can be used only when `session` is set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec *sessionSpec; + +/** + * The spell correction specification that specifies the mode under which spell + * correction takes effect. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec *spellCorrectionSpec; + +/** + * Uses the Engine, ServingConfig and Control freshly read from the database. + * Note: this skips config cache and introduces dependency on databases, which + * could significantly increase the API latency. It should only be used for + * testing, but not serving end users. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *useLatestData; + +/** + * Information about the end user. Highly recommended for analytics and + * personalization. UserInfo.user_agent is used to deduce `device_type` for + * analytics. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserInfo *userInfo; + +/** + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_UserLabels *userLabels; + +/** + * A unique identifier for tracking visitors. For example, this could be + * implemented with an HTTP cookie, which should be able to uniquely identify a + * visitor on a single device. This unique identifier should not change if the + * visitor logs in or out of the website. This field should NOT have a fixed + * value such as `unknown_visitor`. This should be the same identifier as + * UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field + * must be a UTF-8 encoded string with a length limit of 128 characters. + * Otherwise, an `INVALID_ARGUMENT` error is returned. + */ +@property(nonatomic, copy, nullable) NSString *userPseudoId; + +@end + + +/** + * Additional search parameters. For public website search only, supported + * values are: * `user_country_code`: string. Default empty. If set to + * non-empty, results are restricted or boosted based on the location provided. + * For example, `user_country_code: "au"` For available codes see [Country + * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * * `search_type`: double. Default empty. Enables non-webpage searching + * depending on the value. The only valid non-default value is 1, which enables + * image searching. For example, `search_type: 1` + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_Params : GTLRObject +@end + + +/** + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequest_UserLabels : GTLRObject +@end + + +/** + * Boost specification to boost certain documents. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec : GTLRObject + +/** + * Condition boost specifications. If a document matches multiple conditions in + * the specifications, boost scores from these specifications are all applied + * and combined in a non-linear way. Maximum number of specifications is 20. + */ +@property(nonatomic, strong, nullable) NSArray *conditionBoostSpecs; + +@end + + +/** + * Boost applies to documents which match a condition. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec : GTLRObject + +/** + * Strength of the condition boost, which should be in [-1, 1]. Negative boost + * means demotion. Default is 0.0. Setting to 1.0 gives the document a big + * promotion. However, it does not necessarily mean that the boosted document + * will be the top result at all times, nor that other documents will be + * excluded. Results could still be shown even when none of them matches the + * condition. And results that are significantly more relevant to the search + * query can still trump your heavily favored but irrelevant documents. Setting + * to -1.0 gives the document a big demotion. However, results that are deeply + * relevant might still be shown. The document will have an upstream battle to + * get a fairly high ranking, but it is not blocked out completely. Setting to + * 0.0 means no boost applied. The boosting condition is ignored. Only one of + * the (condition, boost) combination or the boost_control_spec below are set. + * If both are set then the global boost is ignored and the more fine-grained + * boost_control_spec is applied. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *boost; + +/** + * Complex specification for custom ranking based on customer defined attribute + * value. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec *boostControlSpec; + +/** + * An expression which specifies a boost condition. The syntax and supported + * fields are the same as a filter expression. See SearchRequest.filter for + * detail syntax and limitations. Examples: * To boost documents with document + * ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: + * ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + */ +@property(nonatomic, copy, nullable) NSString *condition; + +@end + + +/** + * Specification for custom ranking based on customer specified attribute + * value. It provides more controls for customized ranking than the simple + * (condition, boost) combination above. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec : GTLRObject + +/** + * The attribute type to be used to determine the boost amount. The attribute + * value can be derived from the field value of the specified field_name. In + * the case of numerical it is straightforward i.e. attribute_value = + * numerical_field_value. In the case of freshness however, attribute_value = + * (time.now() - datetime_field_value). + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_AttributeTypeUnspecified + * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Freshness + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field specified. + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: + * "FRESHNESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Numerical + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) of + * the control point will be the actual value of the numerical field for + * which the boost_amount is specified. (Value: "NUMERICAL") + */ +@property(nonatomic, copy, nullable) NSString *attributeType; + +/** + * The control points used to define the curve. The monotonic function (defined + * through the interpolation_type above) passes through the control points + * listed here. + */ +@property(nonatomic, strong, nullable) NSArray *controlPoints; + +/** + * The name of the field whose value will be used to determine the boost + * amount. + */ +@property(nonatomic, copy, nullable) NSString *fieldName; + +/** + * The interpolation type to be applied to connect the control points listed + * below. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_InterpolationTypeUnspecified + * Interpolation type is unspecified. In this case, it defaults to + * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_Linear + * Piecewise linear interpolation will be applied. (Value: "LINEAR") + */ +@property(nonatomic, copy, nullable) NSString *interpolationType; + +@end + + +/** + * The control points used to define the curve. The curve defined through these + * control points can only be monotonically increasing or decreasing(constant + * values are acceptable). + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint : GTLRObject + +/** + * Can be one of: 1. The numerical field value. 2. The duration spec for + * freshness: The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this is: + * `nDnM]`. + */ +@property(nonatomic, copy, nullable) NSString *attributeValue; + +/** + * The value between -1 to 1 by which to boost the score if the attribute_value + * evaluates to the value specified above. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *boostAmount; + +@end + + +/** + * A specification for configuring the behavior of content search. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec : GTLRObject + +/** + * Specifies the chunk spec to be returned from the search response. Only + * available if the SearchRequest.ContentSearchSpec.search_result_mode is set + * to CHUNKS + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec *chunkSpec; + +/** + * If there is no extractive_content_spec provided, there will be no extractive + * answer in the search response. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec *extractiveContentSpec; + +/** + * Specifies the search result mode. If unspecified, the search result mode + * defaults to `DOCUMENTS`. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec_SearchResultMode_Chunks + * Returns chunks in the search result. Only available if the + * DocumentProcessingConfig.chunking_config is specified. (Value: + * "CHUNKS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec_SearchResultMode_Documents + * Returns documents in the search result. (Value: "DOCUMENTS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec_SearchResultMode_SearchResultModeUnspecified + * Default value. (Value: "SEARCH_RESULT_MODE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *searchResultMode; + +/** + * If `snippetSpec` is not specified, snippets are not included in the search + * response. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec *snippetSpec; + +/** + * If `summarySpec` is not specified, summaries are not included in the search + * response. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec *summarySpec; + +@end + + +/** + * Specifies the chunk spec to be returned from the search response. Only + * available if the SearchRequest.ContentSearchSpec.search_result_mode is set + * to CHUNKS + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec : GTLRObject + +/** + * The number of next chunks to be returned of the current chunk. The maximum + * allowed value is 3. If not specified, no next chunks will be returned. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *numNextChunks; + +/** + * The number of previous chunks to be returned of the current chunk. The + * maximum allowed value is 3. If not specified, no previous chunks will be + * returned. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *numPreviousChunks; + +@end + + +/** + * A specification for configuring the extractive content in a search response. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec : GTLRObject + +/** + * The maximum number of extractive answers returned in each search result. An + * extractive answer is a verbatim answer extracted from the original document, + * which provides a precise and contextually relevant answer to the search + * query. If the number of matching answers is less than the + * `max_extractive_answer_count`, return all of the answers. Otherwise, return + * the `max_extractive_answer_count`. At most five answers are returned for + * each SearchResult. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxExtractiveAnswerCount; + +/** + * The max number of extractive segments returned in each search result. Only + * applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED + * or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is + * a text segment extracted from the original document that is relevant to the + * search query, and, in general, more verbose than an extractive answer. The + * segment could then be used as input for LLMs to generate summaries and + * answers. If the number of matching segments is less than + * `max_extractive_segment_count`, return all of the segments. Otherwise, + * return the `max_extractive_segment_count`. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxExtractiveSegmentCount; + +/** + * Return at most `num_next_segments` segments after each selected segments. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *numNextSegments; + +/** + * Specifies whether to also include the adjacent from each selected segments. + * Return at most `num_previous_segments` segments before each selected + * segments. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *numPreviousSegments; + +/** + * Specifies whether to return the confidence score from the extractive + * segments in each search result. This feature is available only for new or + * allowlisted data stores. To allowlist your data store, contact your Customer + * Engineer. The default value is `false`. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *returnExtractiveSegmentScore; + +@end + + +/** + * A specification for configuring snippets in a search response. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec : GTLRObject + +/** + * [DEPRECATED] This field is deprecated. To control snippet return, use + * `return_snippet` field. For backwards compatibility, we will return snippet + * if max_snippet_count > 0. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxSnippetCount GTLR_DEPRECATED; + +/** + * [DEPRECATED] This field is deprecated and will have no affect on the + * snippet. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *referenceOnly GTLR_DEPRECATED; + +/** + * If `true`, then return snippet. If no snippet can be generated, we return + * "No snippet is available for this page." A `snippet_status` with `SUCCESS` + * or `NO_SNIPPET_AVAILABLE` will also be returned. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *returnSnippet; + +@end + + +/** + * A specification for configuring a summary returned in a search response. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec : GTLRObject + +/** + * Specifies whether to filter out adversarial queries. The default value is + * `false`. Google employs search-query classification to detect adversarial + * queries. No summary is returned if the search query is classified as an + * adversarial query. For example, a user might ask a question regarding + * negative comments about the company or submit a query designed to generate + * unsafe, policy-violating output. If this field is set to `true`, we skip + * generating summaries for adversarial queries and return fallback messages + * instead. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *ignoreAdversarialQuery; + +/** + * Optional. Specifies whether to filter out jail-breaking queries. The default + * value is `false`. Google employs search-query classification to detect + * jail-breaking queries. No summary is returned if the search query is + * classified as a jail-breaking query. A user might add instructions to the + * query to change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a competing + * company's CEO". If this field is set to `true`, we skip generating summaries + * for jail-breaking queries and return fallback messages instead. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *ignoreJailBreakingQuery; + +/** + * Specifies whether to filter out queries that have low relevance. The default + * value is `false`. If this field is set to `false`, all search results are + * used regardless of relevance to generate answers. If set to `true`, only + * queries with high relevance search results will generate answers. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *ignoreLowRelevantContent; + +/** + * Specifies whether to filter out queries that are not summary-seeking. The + * default value is `false`. Google employs search-query classification to + * detect summary-seeking queries. No summary is returned if the search query + * is classified as a non-summary seeking query. For example, `why is the sky + * blue` and `Who is the best soccer player in the world?` are summary-seeking + * queries, but `SFO airport` and `world cup 2026` are not. They are most + * likely navigational queries. If this field is set to `true`, we skip + * generating summaries for non-summary seeking queries and return fallback + * messages instead. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *ignoreNonSummarySeekingQuery; + +/** + * Specifies whether to include citations in the summary. The default value is + * `false`. When this field is set to `true`, summaries include in-line + * citation numbers. Example summary including citations: BigQuery is Google + * Cloud's fully managed and completely serverless enterprise data warehouse + * [1]. BigQuery supports all data types, works across clouds, and has built-in + * machine learning and business intelligence, all within a unified platform + * [2, 3]. The citation numbers refer to the returned search results and are + * 1-indexed. For example, [1] means that the sentence is attributed to the + * first search result. [2, 3] means that the sentence is attributed to both + * the second and third search results. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *includeCitations; + +/** + * Language code for Summary. Use language tags defined by + * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an + * experimental feature. + */ +@property(nonatomic, copy, nullable) NSString *languageCode; + +/** + * If specified, the spec will be used to modify the prompt provided to the + * LLM. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec *modelPromptSpec; + +/** + * If specified, the spec will be used to modify the model specification + * provided to the LLM. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec *modelSpec; + +/** Optional. Multimodal specification. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec *multimodalSpec; + +/** + * The number of top results to generate the summary from. If the number of + * results returned is less than `summaryResultCount`, the summary is generated + * from all of the results. At most 10 results for documents mode, or 50 for + * chunks mode, can be used to generate a summary. The chunks mode is used when + * SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *summaryResultCount; + +/** + * If true, answer will be generated from most relevant chunks from top search + * results. This feature will improve summary quality. Note that with this + * feature enabled, not all top search results will be referenced and included + * in the reference list, so the citation source index only points to the + * search results listed in the reference list. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *useSemanticChunks; + +@end + + +/** + * Specification of the prompt to use with the model. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec : GTLRObject + +/** + * Text at the beginning of the prompt that instructs the assistant. Examples + * are available in the user guide. + */ +@property(nonatomic, copy, nullable) NSString *preamble; + +@end + + +/** + * Specification of the model. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec : GTLRObject + +/** + * The model version used to generate the summary. Supported values are: * + * `stable`: string. Default value when no value is specified. Uses a generally + * available, fine-tuned model. For more information, see [Answer generation + * model versions and + * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * * `preview`: string. (Public preview) Uses a preview model. For more + * information, see [Answer generation model versions and + * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + */ +@property(nonatomic, copy, nullable) NSString *version; + +@end + + +/** + * Multimodal specification: Will return an image from specified source. If + * multiple sources are specified, the pick is a quality based decision. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec : GTLRObject + +/** + * Optional. Source of image returned in the answer. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_AllAvailableSources + * Behavior when service determines the pick from all available sources. + * (Value: "ALL_AVAILABLE_SOURCES") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_CorpusImageOnly + * Includes image from corpus in the answer. (Value: "CORPUS_IMAGE_ONLY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_FigureGenerationOnly + * Triggers figure generation in the answer. (Value: + * "FIGURE_GENERATION_ONLY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_ImageSourceUnspecified + * Unspecified image source (multimodal feature is disabled by default). + * (Value: "IMAGE_SOURCE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *imageSource; + +@end + + +/** + * A struct to define data stores to filter on in a search call and + * configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error + * is returned. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec : GTLRObject + +/** + * Optional. Boost specification to boost certain documents. For more + * information on boosting, see + * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec *boostSpec; + +/** + * Optional. Custom search operators which if specified will be used to filter + * results from workspace data stores. For more information on custom search + * operators, see + * [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ +@property(nonatomic, copy, nullable) NSString *customSearchOperators; + +/** + * Required. Full resource name of DataStore, such as + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + * The path must include the project number, project id is not supported for + * this field. + */ +@property(nonatomic, copy, nullable) NSString *dataStore; + +/** + * Optional. Filter specification to filter documents in the data store + * specified by data_store field. For more information on filtering, see + * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ +@property(nonatomic, copy, nullable) NSString *filter; + +@end + + +/** + * Specifies features for display, like match highlighting. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec : GTLRObject + +/** + * The condition under which match highlighting should occur. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingConditionUnspecified + * Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. (Value: + * "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled + * Disables match highlighting on all documents. (Value: + * "MATCH_HIGHLIGHTING_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled + * Enables match highlighting on all documents. (Value: + * "MATCH_HIGHLIGHTING_ENABLED") + */ +@property(nonatomic, copy, nullable) NSString *matchHighlightingCondition; + +@end + + +/** + * The specification that uses customized query embedding vector to do semantic + * document retrieval. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec : GTLRObject + +/** The embedding vector used for retrieval. Limit to 1. */ +@property(nonatomic, strong, nullable) NSArray *embeddingVectors; + +@end + + +/** + * Embedding vector. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector : GTLRObject + +/** Embedding field path in schema. */ +@property(nonatomic, copy, nullable) NSString *fieldPath; + +/** + * Query embedding vector. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSArray *vector; + +@end + + +/** + * A facet specification to perform faceted search. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec : GTLRObject + +/** + * Enables dynamic position for this facet. If set to true, the position of + * this facet among all facets in the response is determined automatically. If + * dynamic facets are enabled, it is ordered together. If set to false, the + * position of this facet in the response is the same as in the request, and it + * is ranked before the facets with dynamic position enable and all dynamic + * facets. For example, you may always want to have rating facet returned in + * the response, but it's not necessarily to always display the rating facet at + * the top. In that case, you can set enable_dynamic_position to true so that + * the position of rating facet in response is determined automatically. + * Another example, assuming you have the following facets in the request: * + * "rating", enable_dynamic_position = true * "price", enable_dynamic_position + * = false * "brands", enable_dynamic_position = false And also you have a + * dynamic facets enabled, which generates a facet `gender`. Then the final + * order of the facets in the response can be ("price", "brands", "rating", + * "gender") or ("price", "brands", "gender", "rating") depends on how API + * orders "gender" and "rating" facets. However, notice that "price" and + * "brands" are always ranked at first and second position because their + * enable_dynamic_position is false. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableDynamicPosition; + +/** + * List of keys to exclude when faceting. By default, FacetKey.key is not + * excluded from the filter unless it is listed in this field. Listing a facet + * key in this field allows its values to appear as facet results, even when + * they are filtered out of search results. Using this field does not affect + * what search results are returned. For example, suppose there are 100 + * documents with the color facet "Red" and 200 documents with the color facet + * "Blue". A query containing the filter "color:ANY("Red")" and having "color" + * as FacetKey.key would by default return only "Red" documents in the search + * results, and also return "Red" with count 100 as the only color facet. + * Although there are also blue documents available, "Blue" would not be shown + * as an available facet value. If "color" is listed in "excludedFilterKeys", + * then the query returns the facet values "Red" with count 100 and "Blue" with + * count 200, because the "color" key is now excluded from the filter. Because + * this field doesn't affect search results, the search results are still + * correctly filtered to return only "Red" documents. A maximum of 100 values + * are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ +@property(nonatomic, strong, nullable) NSArray *excludedFilterKeys; + +/** Required. The facet key specification. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey *facetKey; + +/** + * Maximum facet values that are returned for this facet. If unspecified, + * defaults to 20. The maximum allowed value is 300. Values above 300 are + * coerced to 300. For aggregation in healthcare search, when the + * [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden + * to 10,000 internally, regardless of the value set here. If this field is + * negative, an `INVALID_ARGUMENT` is returned. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *limit; + +@end + + +/** + * Specifies how a facet is computed. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey : GTLRObject + +/** + * True to make facet keys case insensitive when getting faceting values with + * prefixes or contains; false otherwise. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *caseInsensitive; + +/** + * Only get facet values that contain the given strings. For example, suppose + * "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > + * 2022". If set "contains" to "2022", the "category" facet only contains + * "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. + * Maximum is 10. + */ +@property(nonatomic, strong, nullable) NSArray *contains; + +/** + * Set only if values should be bucketed into intervals. Must be set for facets + * with numerical values. Must not be set for facet with text values. Maximum + * number of intervals is 30. + */ +@property(nonatomic, strong, nullable) NSArray *intervals; + +/** + * Required. Supported textual and numerical facet keys in Document object, + * over which the facet values are computed. Facet key is case-sensitive. + */ +@property(nonatomic, copy, nullable) NSString *key; + +/** + * The order in which documents are returned. Allowed values are: * "count + * desc", which means order by SearchResponse.Facet.values.count descending. * + * "value desc", which means order by SearchResponse.Facet.values.value + * descending. Only applies to textual facets. If not set, textual values are + * sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); + * numerical intervals are sorted in the order given by + * FacetSpec.FacetKey.intervals. + */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Only get facet values that start with the given string prefix. For example, + * suppose "category" has three values "Action > 2022", "Action > 2021" and + * "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only + * contains "Action > 2022" and "Action > 2021". Only supported on textual + * fields. Maximum is 10. + */ +@property(nonatomic, strong, nullable) NSArray *prefixes; + +/** + * Only get facet for the given restricted values. Only supported on textual + * fields. For example, suppose "category" has three values "Action > 2022", + * "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > + * 2022", the "category" facet only contains "Action > 2022". Only supported on + * textual fields. Maximum is 10. + */ +@property(nonatomic, strong, nullable) NSArray *restrictedValues; + +@end + + +/** + * Specifies the image query input. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery : GTLRObject + +/** + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. + */ +@property(nonatomic, copy, nullable) NSString *imageBytes; + +@end + + +/** + * Specification to enable natural language understanding capabilities for + * search requests. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec : GTLRObject + +/** + * Optional. Allowlist of fields that can be used for natural language filter + * extraction. By default, if this is unspecified, all indexable fields are + * eligible for natural language filter extraction (but are not guaranteed to + * be used). If any fields are specified in allowed_field_names, only the + * fields that are both marked as indexable in the schema and specified in the + * allowlist will be eligible for natural language filter extraction. Note: for + * multi-datastore search, this is not yet supported, and will be ignored. + */ +@property(nonatomic, strong, nullable) NSArray *allowedFieldNames; + +/** + * Optional. Controls behavior of how extracted filters are applied to the + * search. The default behavior depends on the request. For single datastore + * structured search, the default is `HARD_FILTER`. For multi-datastore search, + * the default behavior is `SOFT_BOOST`. Location-based filters are always + * applied as hard filters, and the `SOFT_BOOST` setting will not affect them. + * This field is only used if + * SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition + * is set to FilterExtractionCondition.ENABLED. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified + * `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior + * for extracted filters. For single datastore search, the default is to + * apply as hard filters. For multi-datastore search, the default is to + * apply as soft boosts. (Value: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter + * Applies all extracted filters as hard filters on the results. Results + * that do not pass the extracted filters will not be returned in the + * result set. (Value: "HARD_FILTER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost + * Applies all extracted filters as soft boosts. Results that pass the + * filters will be boosted up to higher ranks in the result set. (Value: + * "SOFT_BOOST") + */ +@property(nonatomic, copy, nullable) NSString *extractedFilterBehavior; + +/** + * The condition under which filter extraction should occur. Server behavior + * defaults to `DISABLED`. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified + * Server behavior defaults to `DISABLED`. (Value: + * "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled + * Disables NL filter extraction. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled + * Enables NL filter extraction. (Value: "ENABLED") + */ +@property(nonatomic, copy, nullable) NSString *filterExtractionCondition; + +/** + * Field names used for location-based filtering, where geolocation filters are + * detected in natural language search queries. Only valid when the + * FilterExtractionCondition is set to `ENABLED`. If this field is set, it + * overrides the field names set in + * ServingConfig.geo_search_query_detection_field_names. + */ +@property(nonatomic, strong, nullable) NSArray *geoSearchQueryDetectionFieldNames; + +@end + + +/** + * The specification for personalization. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec : GTLRObject + +/** + * The personalization mode of the search request. Defaults to Mode.AUTO. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec_Mode_Auto + * Personalization is enabled if data quality requirements are met. + * (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec_Mode_Disabled + * Disable personalization. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec_Mode_ModeUnspecified + * Default value. In this case, server behavior defaults to Mode.AUTO. + * (Value: "MODE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *mode; + +@end + + +/** + * Specification to determine under which conditions query expansion should + * occur. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec : GTLRObject + +/** + * The condition under which query expansion should occur. Default to + * Condition.DISABLED. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec_Condition_Auto + * Automatic query expansion built by the Search API. (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec_Condition_ConditionUnspecified + * Unspecified query expansion condition. In this case, server behavior + * defaults to Condition.DISABLED. (Value: "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec_Condition_Disabled + * Disabled query expansion. Only the exact search query is used, even if + * SearchResponse.total_size is zero. (Value: "DISABLED") + */ +@property(nonatomic, copy, nullable) NSString *condition; + +/** + * Whether to pin unexpanded results. If this field is set to true, unexpanded + * products are always at the top of the search results, followed by the + * expanded results. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *pinUnexpandedResults; + +@end + + +/** + * The specification for returning the document relevance score. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec : GTLRObject + +/** + * Optional. Whether to return the relevance score for search results. The + * higher the score, the more relevant the document is to the query. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *returnRelevanceScore; + +@end + + +/** + * SearchAddonSpec is used to disable add-ons for search as per new repricing + * model. By default if the SearchAddonSpec is not specified, we consider that + * the customer wants to enable them wherever applicable. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec : GTLRObject + +/** + * Optional. If true, generative answer add-on is disabled. Generative answer + * add-on includes natural language to filters and simple answers. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disableGenerativeAnswerAddOn; + +/** + * Optional. If true, disables event re-ranking and personalization to optimize + * KPIs & personalize results. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disableKpiPersonalizationAddOn; + +/** + * Optional. If true, semantic add-on is disabled. Semantic add-on includes + * embeddings and jetstream. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disableSemanticAddOn; + +@end + + +/** + * Specification for search as you type in search requests. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec : GTLRObject + +/** + * The condition under which search as you type should occur. Default to + * Condition.DISABLED. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_Auto + * Automatic switching between search-as-you-type and standard search + * modes, ideal for single-API implementations (e.g., debouncing). + * (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_ConditionUnspecified + * Server behavior defaults to Condition.DISABLED. (Value: + * "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_Disabled + * Disables Search As You Type. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec_Condition_Enabled + * Enables Search As You Type. (Value: "ENABLED") + */ +@property(nonatomic, copy, nullable) NSString *condition; + +@end + + +/** + * Session specification. Multi-turn Search feature is currently at private GA + * stage. Please use v1alpha or v1beta version instead before we launch this + * feature to public GA. Or ask for allowlisting through Google Support team. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec : GTLRObject + +/** + * If set, the search result gets stored to the "turn" specified by this query + * ID. Example: Let's say the session looks like this: session { name: + * ".../sessions/xxx" turns { query { text: "What is foo?" query_id: + * ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How + * about bar then?" query_id: ".../questions/zzz" } } } The user can call + * /search API with a request like this: session: ".../sessions/xxx" + * session_spec { query_id: ".../questions/zzz" } Then, the API stores the + * search result, associated with the last turn. The stored search result can + * be used by a subsequent /answer API call (with the session ID and the query + * ID specified). Also, it is possible to call /search and /answer in parallel + * with the same session ID & query ID. + */ +@property(nonatomic, copy, nullable) NSString *queryId; + +/** + * The number of top search results to persist. The persisted search results + * can be used for the subsequent /answer api call. This field is similar to + * the `summary_result_count` field in + * SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 + * results for documents mode, or 50 for chunks mode. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *searchResultPersistenceCount; + +@end + + +/** + * The specification for query spell correction. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec : GTLRObject + +/** + * The mode under which spell correction replaces the original search query. + * Defaults to Mode.AUTO. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec_Mode_Auto + * Automatic spell correction built by the Search API. Search will be + * based on the corrected query if found. (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec_Mode_ModeUnspecified + * Unspecified spell correction mode. In this case, server behavior + * defaults to Mode.AUTO. (Value: "MODE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec_Mode_SuggestionOnly + * Search API tries to find a spelling suggestion. If a suggestion is + * found, it is put in the SearchResponse.corrected_query. The spelling + * suggestion won't be used as the search query. (Value: + * "SUGGESTION_ONLY") + */ +@property(nonatomic, copy, nullable) NSString *mode; + +@end + + +/** + * External session proto definition. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession : GTLRObject + +/** + * Optional. The display name of the session. This field is used to identify + * the session in the UI. By default, the display name is the first turn query + * text in the session. + */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** Output only. The time the session finished. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; + +/** + * Optional. Whether the session is pinned, pinned session will be displayed on + * the top of the session list. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isPinned; + +/** + * Immutable. Fully qualified name + * `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/ + * *` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Output only. The time the session started. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; + +/** + * The state of the session. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession_State_InProgress + * The session is currently open. (Value: "IN_PROGRESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession_State_StateUnspecified + * State is unspecified. (Value: "STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** Turns. */ +@property(nonatomic, strong, nullable) NSArray *turns; + +/** A unique identifier for tracking users. */ +@property(nonatomic, copy, nullable) NSString *userPseudoId; + +@end + + +/** + * Represents a turn, including a query from the user and a answer from + * service. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn : GTLRObject + +/** + * Optional. The resource name of the answer to the user query. Only set if the + * answer generation (/answer API call) happened in this turn. + */ +@property(nonatomic, copy, nullable) NSString *answer; + +/** + * Output only. In ConversationalSearchService.GetSession API, if + * GetSessionRequest.include_answer_details is set to true, this field will be + * populated when getting answer query session. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAnswer *detailedAnswer; + +/** + * Output only. In ConversationalSearchService.GetSession API, if + * GetSessionRequest.include_answer_details is set to true, this field will be + * populated when getting assistant session. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaAssistAnswer *detailedAssistAnswer; + +/** + * Optional. The user query. May not be set if this turn is merely regenerating + * an answer to a different turn + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaQuery *query; + +/** + * Optional. Represents metadata related to the query config, for example LLM + * model and version used, model parameters (temperature, grounding parameters, + * etc.). The prefix "google." is reserved for Google-developed functionality. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn_QueryConfig *queryConfig; + +@end + + +/** + * Optional. Represents metadata related to the query config, for example LLM + * model and version used, model parameters (temperature, grounding parameters, + * etc.). The prefix "google." is reserved for Google-developed functionality. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSessionTurn_QueryConfig : GTLRObject +@end + + +/** + * Metadata related to the progress of the + * CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be + * returned by the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Response message for CrawlRateManagementService.SetDedicatedCrawlRate + * method. It simply returns the state of the response, and an error message if + * the state is FAILED. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse : GTLRObject + +/** Errors from service when handling the request. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; + +/** + * Output only. The state of the response. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse_State_Failed + * The state is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse_State_StateUnspecified + * The state is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse_State_Succeeded + * The state is successful. (Value: "SUCCEEDED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +@end + + +/** + * Metadata for DataConnectorService.SetUpDataConnector method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata : GTLRObject +@end + + +/** + * Metadata related to the progress of the + * SiteSearchEngineService.SetUriPatternDocumentData operation. This will be + * returned by the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Response message for SiteSearchEngineService.SetUriPatternDocumentData + * method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse : GTLRObject +@end + + +/** + * Metadata for single-regional CMEKs. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSingleRegionKey : GTLRObject + +/** + * Required. Single-regional kms key resource name which will be used to + * encrypt resources + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + */ +@property(nonatomic, copy, nullable) NSString *kmsKey; + +@end + + +/** + * A sitemap for the SiteSearchEngine. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSitemap : GTLRObject + +/** Output only. The sitemap's creation time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Output only. The fully qualified resource name of the sitemap. `projects/ * + * /locations/ * /collections/ * /dataStores/ * /siteSearchEngine/sitemaps/ *` + * The `sitemap_id` suffix is system-generated. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. */ +@property(nonatomic, copy, nullable) NSString *uri; + +@end + + +/** + * Verification information for target sites in advanced site search. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo : GTLRObject + +/** + * Site verification state indicating the ownership and validity. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_Exempted + * Site exempt from verification, e.g., a public website that opens to + * all. (Value: "EXEMPTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_SiteVerificationStateUnspecified + * Defaults to VERIFIED. (Value: "SITE_VERIFICATION_STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_Unverified + * Site ownership pending verification or verification failed. (Value: + * "UNVERIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo_SiteVerificationState_Verified + * Site ownership verified. (Value: "VERIFIED") + */ +@property(nonatomic, copy, nullable) NSString *siteVerificationState; + +/** Latest site verification time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *verifyTime; + +@end + + +/** + * A target site for the SiteSearchEngine. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite : GTLRObject + +/** + * Immutable. If set to false, a uri_pattern is generated to include all pages + * whose address contains the provided_uri_pattern. If set to true, an + * uri_pattern is generated to try to be an exact match of the + * provided_uri_pattern or just the specific page if the provided_uri_pattern + * is a specific one. provided_uri_pattern is always normalized to generate the + * URI pattern to be used by the search engine. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *exactMatch; + +/** Output only. Failure reason. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason *failureReason; + +/** + * Output only. This is system-generated based on the provided_uri_pattern. + */ +@property(nonatomic, copy, nullable) NSString *generatedUriPattern; + +/** + * Output only. Indexing status. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Cancellable + * The target site change is pending but cancellable. (Value: + * "CANCELLABLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Cancelled + * The target site change is cancelled. (Value: "CANCELLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Deleting + * The previously indexed target site has been marked to be deleted. This + * is a transitioning state which will resulted in either: 1. target site + * deleted if unindexing is successful; 2. state reverts to SUCCEEDED if + * the unindexing fails. (Value: "DELETING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Failed + * The target site fails to be indexed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_IndexingStatusUnspecified + * Defaults to SUCCEEDED. (Value: "INDEXING_STATUS_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Pending + * The target site is in the update queue and will be picked up by + * indexing pipeline. (Value: "PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_IndexingStatus_Succeeded + * The target site has been indexed. (Value: "SUCCEEDED") + */ +@property(nonatomic, copy, nullable) NSString *indexingStatus; + +/** + * Output only. The fully qualified resource name of the target site. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + * The `target_site_id` is system-generated. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Required. Input only. The user provided URI pattern from which the + * `generated_uri_pattern` is generated. + */ +@property(nonatomic, copy, nullable) NSString *providedUriPattern; + +/** Output only. Root domain of the provided_uri_pattern. */ +@property(nonatomic, copy, nullable) NSString *rootDomainUri; + +/** Output only. Site ownership and validity verification status. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo *siteVerificationInfo; + +/** + * The type of the target site, e.g., whether the site is to be included or + * excluded. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_Type_Exclude + * Exclude the target site. (Value: "EXCLUDE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_Type_Include + * Include the target site. (Value: "INCLUDE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSite_Type_TypeUnspecified + * This value is unused. In this case, server behavior defaults to + * Type.INCLUDE. (Value: "TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *type; + +/** Output only. The target site's last updated time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Site search indexing failure reasons. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason : GTLRObject + +/** Failed due to insufficient quota. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure *quotaFailure; + +@end + + +/** + * Failed due to insufficient quota. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure : GTLRObject + +/** + * This number is an estimation on how much total quota this project needs to + * successfully complete indexing. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalRequiredQuota; + +@end + + +/** + * Tenant information for a connector source. This includes some of the same + * information stored in the Credential message, but is limited to only what is + * needed to provide a list of accessible tenants to the user. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTenant : GTLRObject + +/** Optional display name for the tenant, e.g. "My Slack Team". */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** + * The tenant's instance ID. Examples: Jira + * ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). + * + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + */ +@property(nonatomic, copy, nullable) NSString *identifier; + +/** + * The URI of the tenant, if applicable. For example, the URI of a Jira + * instance is https://my-jira-instance.atlassian.net, and a Slack tenant does + * not have a URI. + */ +@property(nonatomic, copy, nullable) NSString *uri; + +@end + + +/** + * Metadata related to the progress of the TrainCustomModel operation. This is + * returned by the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Response of the TrainCustomModelRequest. This message is returned by the + * google.longrunning.Operations.response field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse : GTLRObject + +/** Echoes the destination for the complete errors in the request if set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaImportErrorConfig *errorConfig; + +/** A sample of errors encountered while processing the data. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** The metrics of the trained model. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse_Metrics *metrics; + +/** Fully qualified name of the CustomTuningModel. */ +@property(nonatomic, copy, nullable) NSString *modelName; + +/** + * The trained model status. Possible values are: * **bad-data**: The training + * data quality is bad. * **no-improvement**: Tuning didn't improve + * performance. Won't deploy. * **in-progress**: Model training job creation is + * in progress. * **training**: Model is actively training. * **evaluating**: + * The model is evaluating trained metrics. * **indexing**: The model trained + * metrics are indexing. * **ready**: The model is ready for serving. + */ +@property(nonatomic, copy, nullable) NSString *modelStatus; + +@end + + +/** + * The metrics of the trained model. + * + * @note This class is documented as having more properties of NSNumber (Uses + * NSNumber of doubleValue.). Use @c -additionalJSONKeys and @c + * -additionalPropertyForName: to get the list of properties and then + * fetch them; or @c -additionalProperties to fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse_Metrics : GTLRObject +@end + + +/** + * Metadata associated with a tune operation. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata : GTLRObject + +/** + * Required. The resource name of the engine that this tune applies to. Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + */ +@property(nonatomic, copy, nullable) NSString *engine; + +@end + + +/** + * Response associated with a tune operation. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaTuneEngineResponse : GTLRObject +@end + + +/** + * Metadata related to the progress of the CmekConfigService.UpdateCmekConfig + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateCmekConfigMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Metadata related to the progress of the CollectionService.UpdateCollection + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateCollectionMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Metadata for UpdateSchema LRO. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Request for UpdateSession method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest : GTLRObject + +/** Required. The Session to update. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaSession *session; + +/** + * Indicates which fields in the provided Session to update. The following are + * NOT supported: * Session.name If not set or empty, all supported fields are + * updated. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +@end + + +/** + * Metadata related to the progress of the + * SiteSearchEngineService.UpdateTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Information of an end user. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserInfo : GTLRObject + +/** Optional. IANA time zone, e.g. Europe/Budapest. */ +@property(nonatomic, copy, nullable) NSString *timeZone; + +/** + * User agent as included in the HTTP header. The field must be a UTF-8 encoded + * string with a length limit of 1,000 characters. Otherwise, an + * `INVALID_ARGUMENT` error is returned. This should not be set when using the + * client side event reporting with GTM or JavaScript tag in + * UserEventService.CollectUserEvent or if UserEvent.direct_user_request is + * set. + */ +@property(nonatomic, copy, nullable) NSString *userAgent; + +/** + * Highly recommended for logged-in users. Unique identifier for logged-in + * user, such as a user name. Don't set for anonymous users. Always use a + * hashed value for this ID. Don't set the field to the same fixed ID for + * different users. This mixes the event history of those users together, which + * results in degraded model quality. The field must be a UTF-8 encoded string + * with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` + * error is returned. + */ +@property(nonatomic, copy, nullable) NSString *userId; + +@end + + +/** + * User License information assigned by the admin. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1alphaUserLicense : GTLRObject + +/** Output only. User created timestamp. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Output only. User last logged in time. If the user has not logged in yet, + * this field will be empty. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *lastLoginTime; + +/** + * Output only. License assignment state of the user. If the user is assigned + * with a license config, the user login will be assigned with the license; If + * the user's license assignment state is unassigned or unspecified, no license * config will be associated to the user; * * Likely values: @@ -17605,6 +19712,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe */ @property(nonatomic, copy, nullable) NSString *domain; +/** + * The mime type of the document. + * https://www.iana.org/assignments/media-types/media-types.xhtml. + */ +@property(nonatomic, copy, nullable) NSString *mimeType; + /** Page identifier. */ @property(nonatomic, copy, nullable) NSString *pageIdentifier; @@ -17708,6 +19821,22 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * The configuration for the BAP connector. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig : GTLRObject + +/** Optional. The actions enabled on the associated BAP connection. */ +@property(nonatomic, strong, nullable) NSArray *enabledActions; + +/** + * Required. The supported connector modes for the associated BAP connection. + */ +@property(nonatomic, strong, nullable) NSArray *supportedConnectorModes; + +@end + + /** * Metadata related to the progress of the * SiteSearchEngineService.BatchCreateTargetSites operation. This will be @@ -17801,18 +19930,251 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * The value of the matcher that was used to match the Document. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue : GTLRObject - -/** - * Format: - * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + * The value of the matcher that was used to match the Document. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue : GTLRObject + +/** + * Format: + * projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + */ +@property(nonatomic, copy, nullable) NSString *fhirResource; + +/** If match by URI, the URI of the Document. */ +@property(nonatomic, copy, nullable) NSString *uri; + +@end + + +/** + * Metadata related to the progress of the + * UserLicenseService.BatchUpdateUserLicenses operation. This will be returned + * by the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Count of user licenses that failed to be updated. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *failureCount; + +/** + * Count of user licenses successfully updated. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *successCount; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Request message for UserLicenseService.BatchUpdateUserLicenses method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest : GTLRObject + +/** + * Optional. If true, if user licenses removed associated license config, the + * user license will be deleted. By default which is false, the user license + * will be updated to unassigned state. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *deleteUnassignedUserLicenses; + +/** The inline source for the input content for document embeddings. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource *inlineSource; + +@end + + +/** + * The inline source for the input config for BatchUpdateUserLicenses method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource : GTLRObject + +/** + * Optional. The list of fields to update. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Required. A list of user licenses to update. Each user license must have a + * valid UserLicense.user_principal. + */ +@property(nonatomic, strong, nullable) NSArray *userLicenses; + +@end + + +/** + * Response message for UserLicenseService.BatchUpdateUserLicenses method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** UserLicenses successfully updated. */ +@property(nonatomic, strong, nullable) NSArray *userLicenses; + +@end + + +/** + * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest : GTLRObject +@end + + +/** + * Access Control Configuration. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAclConfig : GTLRObject + +/** Identity provider config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig *idpConfig; + +/** + * Immutable. The full resource name of the acl configuration. Format: + * `projects/{project}/locations/{location}/aclConfig`. This field must be a + * UTF-8 encoded string with a length limit of 1024 characters. + */ +@property(nonatomic, copy, nullable) NSString *name; + +@end + + +/** + * Configuration data for advance site search. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig : GTLRObject + +/** + * If set true, automatic refresh is disabled for the DataStore. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disableAutomaticRefresh; + +/** + * If set true, initial indexing is disabled for the DataStore. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disableInitialIndex; + +@end + + +/** + * The resource level alert config. Used in: * UserLicense * EngineUserData The + * AlertPolicyConfig in data connector is of same usage. No easy way to + * migrate. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig : GTLRObject + +/** Optional. The enrollment state of each alert. */ +@property(nonatomic, strong, nullable) NSArray *alertEnrollments; + +/** Immutable. The fully qualified resource name of the AlertPolicy. */ +@property(nonatomic, copy, nullable) NSString *alertPolicy; + +/** Optional. The contact details for each alert policy. */ +@property(nonatomic, strong, nullable) NSArray *contactDetails; + +/** Optional. The language code used for notifications */ +@property(nonatomic, copy, nullable) NSString *languageCode; + +@end + + +/** + * The alert enrollment status. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment : GTLRObject + +/** Immutable. The id of an alert. */ +@property(nonatomic, copy, nullable) NSString *alertId; + +/** + * Required. The enrollment status of a customer. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Declined + * Customer declined this policy. (Value: "DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_Enrolled + * Customer is enrolled in this policy. (Value: "ENROLLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_EnrollState_EnrollStateUnspecified + * Default value. Used for customers who have not responded to the alert + * policy. (Value: "ENROLL_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *enrollState; + +/** + * Optional. Parameters used to instantiate a notification. Used for + * notifications that are triggered when registered. Not stored. * Gemini + * Business welcome emails. * Gemini Business user invitation emails. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_NotificationParams *notificationParams; + +@end + + +/** + * Optional. Parameters used to instantiate a notification. Used for + * notifications that are triggered when registered. Not stored. * Gemini + * Business welcome emails. * Gemini Business user invitation emails. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfigAlertEnrollment_NotificationParams : GTLRObject +@end + + +/** + * Metadata related to the progress of the + * SiteSearchEngineService.BatchCreateTargetSites operation. This will be + * returned by the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. */ -@property(nonatomic, copy, nullable) NSString *fhirResource; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse : GTLRObject -/** If match by URI, the URI of the Document. */ -@property(nonatomic, copy, nullable) NSString *uri; +/** TargetSites created. */ +@property(nonatomic, strong, nullable) NSArray *targetSites; @end @@ -17822,7 +20184,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe * UserLicenseService.BatchUpdateUserLicenses operation. This will be returned * by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -17851,639 +20213,849 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Request message for UserLicenseService.BatchUpdateUserLicenses method. + * Response message for UserLicenseService.BatchUpdateUserLicenses method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** UserLicenses successfully updated. */ +@property(nonatomic, strong, nullable) NSArray *userLicenses; + +@end + /** - * Optional. If true, if user licenses removed associated license config, the - * user license will be deleted. By default which is false, the user license - * will be updated to unassigned state. + * Configurations used to enable CMEK data encryption with Cloud KMS keys. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig : GTLRObject + +/** + * Output only. The default CmekConfig for the Customer. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *deleteUnassignedUserLicenses; +@property(nonatomic, strong, nullable) NSNumber *isDefault; -/** The inline source for the input content for document embeddings. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource *inlineSource; +/** + * Required. KMS key resource name which will be used to encrypt resources + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + */ +@property(nonatomic, copy, nullable) NSString *kmsKey; -@end +/** + * Output only. KMS key version resource name which will be used to encrypt + * resources `/cryptoKeyVersions/{keyVersion}`. + */ +@property(nonatomic, copy, nullable) NSString *kmsKeyVersion; +/** + * Output only. The timestamp of the last key rotation. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *lastRotationTimestampMicros; /** - * The inline source for the input config for BatchUpdateUserLicenses method. + * Required. The name of the CmekConfig of the form + * `projects/{project}/locations/{location}/cmekConfig` or + * `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource : GTLRObject +@property(nonatomic, copy, nullable) NSString *name; /** - * Optional. The list of fields to update. + * Output only. Whether the NotebookLM Corpus is ready to be used. * - * String format is a comma-separated list of fields. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmNotEnabled + * The NotebookLM is not enabled. (Value: "NOTEBOOK_LM_NOT_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmNotReady + * The NotebookLM is not ready. (Value: "NOTEBOOK_LM_NOT_READY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmReady + * The NotebookLM is ready to be used. (Value: "NOTEBOOK_LM_READY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmStateUnspecified + * The NotebookLM state is unknown. (Value: + * "NOTEBOOK_LM_STATE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *updateMask; +@property(nonatomic, copy, nullable) NSString *notebooklmState; /** - * Required. A list of user licenses to update. Each user license must have a - * valid UserLicense.user_principal. + * Optional. Single-regional CMEKs that are required for some VAIS features. */ -@property(nonatomic, strong, nullable) NSArray *userLicenses; +@property(nonatomic, strong, nullable) NSArray *singleRegionKeys; + +/** + * Output only. The states of the CmekConfig. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Active + * The CmekConfig can be used with DataStores. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_ActiveRotating + * The KMS key version is being rotated. (Value: "ACTIVE_ROTATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Creating + * The CmekConfig is creating. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleted + * The KMS key is soft deleted. Some cleanup policy will eventually be + * applied. (Value: "DELETED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_DeleteFailed + * The CmekConfig deletion process failed. (Value: "DELETE_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleting + * The CmekConfig is deleting. (Value: "DELETING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Expired + * The KMS key is expired, meaning the key has been disabled for 30+ + * days. The customer can call DeleteCmekConfig to change the state to + * DELETED. (Value: "EXPIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_KeyIssue + * The CmekConfig is unavailable, most likely due to the KMS Key being + * revoked. (Value: "KEY_ISSUE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_StateUnspecified + * The CmekConfig state is unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Unusable + * The CmekConfig is not usable, most likely due to some internal issue. + * (Value: "UNUSABLE") + */ +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Response message for UserLicenseService.BatchUpdateUserLicenses method. + * Defines circumstances to be checked before allowing a behavior */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCondition : GTLRObject -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * Range of time(s) specifying when condition is active. Maximum of 10 time + * ranges. + */ +@property(nonatomic, strong, nullable) NSArray *activeTimeRange; -/** UserLicenses successfully updated. */ -@property(nonatomic, strong, nullable) NSArray *userLicenses; +/** + * Optional. Query regex to match the whole search query. Cannot be set when + * Condition.query_terms is set. Only supported for Basic Site Search promotion + * serving controls. + */ +@property(nonatomic, copy, nullable) NSString *queryRegex; + +/** + * Search only A list of terms to match the query on. Cannot be set when + * Condition.query_regex is set. Maximum of 10 query terms. + */ +@property(nonatomic, strong, nullable) NSArray *queryTerms; @end /** - * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. + * Matcher for search request query */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionQueryTerm : GTLRObject + +/** + * Whether the search query needs to exactly match the query term. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *fullMatch; + +/** + * The specific query value to match against Must be lowercase, must be UTF-8. + * Can have at most 3 space separated terms if full_match is true. Cannot be an + * empty string. Maximum length of 5000 characters. + */ +@property(nonatomic, copy, nullable) NSString *value; + @end /** - * Access Control Configuration. + * Used for time-dependent conditions. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAclConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionTimeRange : GTLRObject + +/** End of time range. Range is inclusive. Must be in the future. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; + +/** Start of time range. Range is inclusive. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; + +@end -/** Identity provider config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig *idpConfig; /** - * Immutable. The full resource name of the acl configuration. Format: - * `projects/{project}/locations/{location}/aclConfig`. This field must be a - * UTF-8 encoded string with a length limit of 1024 characters. + * The contact info stored in resource level. If both project level and + * resource level is populated, the resource level contact info will override + * the project level contact info. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaContactDetails : GTLRObject + +/** Optional. The email address of the contact. */ +@property(nonatomic, copy, nullable) NSString *emailAddress; @end /** - * Configuration data for advance site search. + * Defines a conditioned behavior to employ during serving. Must be attached to + * a ServingConfig to be considered at serving time. Permitted actions + * dependent on `SolutionType`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl : GTLRObject /** - * If set true, automatic refresh is disabled for the DataStore. - * - * Uses NSNumber of boolValue. + * Output only. List of all ServingConfig IDs this control is attached to. May + * take up to 10 minutes to update after changes. */ -@property(nonatomic, strong, nullable) NSNumber *disableAutomaticRefresh; +@property(nonatomic, strong, nullable) NSArray *associatedServingConfigIds; + +/** Defines a boost-type control */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostAction *boostAction; /** - * If set true, initial indexing is disabled for the DataStore. - * - * Uses NSNumber of boolValue. + * Determines when the associated action will trigger. Omit to always apply the + * action. Currently only a single condition may be specified. Otherwise an + * INVALID ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSNumber *disableInitialIndex; +@property(nonatomic, strong, nullable) NSArray *conditions; -@end +/** + * Required. Human readable name. The identifier used in UI views. Must be + * UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID + * ARGUMENT error is thrown. + */ +@property(nonatomic, copy, nullable) NSString *displayName; +/** Defines a filter-type control Currently not supported by Recommendation */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlFilterAction *filterAction; /** - * Metadata related to the progress of the - * SiteSearchEngineService.BatchCreateTargetSites operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Immutable. Fully qualified name `projects/ * /locations/global/dataStore/ * + * /controls/ *` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *name; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Promote certain links based on predefined trigger queries. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlPromoteAction *promoteAction; + +/** Defines a redirect-type control. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlRedirectAction *redirectAction; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Required. Immutable. What solution the control belongs to. Must be + * compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is + * thrown. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeChat + * Used for use cases related to the Generative AI agent. (Value: + * "SOLUTION_TYPE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeGenerativeChat + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled + * with `SOLUTION_TYPE_CHAT` solution. (Value: + * "SOLUTION_TYPE_GENERATIVE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeRecommendation + * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeSearch + * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeUnspecified + * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *solutionType; + +/** Treats a group of terms as synonyms of one another. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlSynonymsAction *synonymsAction; + +/** + * Specifies the use case for the control. Affects what condition fields can be + * set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case + * per control. Must be set when solution_type is + * SolutionType.SOLUTION_TYPE_SEARCH. + */ +@property(nonatomic, strong, nullable) NSArray *useCases; @end /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * Adjusts order of products in returned list. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse : GTLRObject - -/** TargetSites created. */ -@property(nonatomic, strong, nullable) NSArray *targetSites; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostAction : GTLRObject /** - * Metadata related to the progress of the - * UserLicenseService.BatchUpdateUserLicenses operation. This will be returned - * by the google.longrunning.Operation.metadata field. + * Strength of the boost, which should be in [-1, 1]. Negative boost means + * demotion. Default is 0.0 (No-op). + * + * Uses NSNumber of floatValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *boost GTLR_DEPRECATED; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Required. Specifies which data store's documents can be boosted by this + * control. Full data store name e.g. + * projects/123/locations/global/collections/default_collection/dataStores/default_data_store + */ +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * Count of user licenses that failed to be updated. - * - * Uses NSNumber of longLongValue. + * Required. Specifies which products to apply the boost to. If no filter is + * provided all products will be boosted (No-op). Syntax documentation: + * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 + * characters. Otherwise an INVALID ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *filter; /** - * Count of user licenses successfully updated. + * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost + * means demotion. Default is 0.0 (No-op). * - * Uses NSNumber of longLongValue. + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, strong, nullable) NSNumber *fixedBoost; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Complex specification for custom ranking based on customer defined + * attribute value. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec *interpolationBoostSpec; @end /** - * Response message for UserLicenseService.BatchUpdateUserLicenses method. + * Specification for custom ranking based on customer specified attribute + * value. It provides more controls for customized ranking than the simple + * (condition, boost) combination above. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse : GTLRObject - -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; - -/** UserLicenses successfully updated. */ -@property(nonatomic, strong, nullable) NSArray *userLicenses; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec : GTLRObject -@end +/** + * Optional. The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness however, + * attribute_value = (time.now() - datetime_field_value). + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_AttributeType_AttributeTypeUnspecified + * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_AttributeType_Freshness + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field specified. + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: + * "FRESHNESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_AttributeType_Numerical + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) of + * the control point will be the actual value of the numerical field for + * which the boost_amount is specified. (Value: "NUMERICAL") + */ +@property(nonatomic, copy, nullable) NSString *attributeType; +/** + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through the + * control points listed here. + */ +@property(nonatomic, strong, nullable) NSArray *controlPoints; /** - * Configurations used to enable CMEK data encryption with Cloud KMS keys. + * Optional. The name of the field whose value will be used to determine the + * boost amount. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *fieldName; /** - * Output only. The default CmekConfig for the Customer. + * Optional. The interpolation type to be applied to connect the control points + * listed below. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified + * Interpolation type is unspecified. In this case, it defaults to + * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_Linear + * Piecewise linear interpolation will be applied. (Value: "LINEAR") */ -@property(nonatomic, strong, nullable) NSNumber *isDefault; +@property(nonatomic, copy, nullable) NSString *interpolationType; + +@end + /** - * Required. KMS key resource name which will be used to encrypt resources - * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + * The control points used to define the curve. The curve defined through these + * control points can only be monotonically increasing or decreasing(constant + * values are acceptable). */ -@property(nonatomic, copy, nullable) NSString *kmsKey; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint : GTLRObject /** - * Output only. KMS key version resource name which will be used to encrypt - * resources `/cryptoKeyVersions/{keyVersion}`. + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec + * for freshness: The value must be formatted as an XSD `dayTimeDuration` value + * (a restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. */ -@property(nonatomic, copy, nullable) NSString *kmsKeyVersion; +@property(nonatomic, copy, nullable) NSString *attributeValue; /** - * Output only. The timestamp of the last key rotation. + * Optional. The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *lastRotationTimestampMicros; +@property(nonatomic, strong, nullable) NSNumber *boostAmount; + +@end + /** - * Required. The name of the CmekConfig of the form - * `projects/{project}/locations/{location}/cmekConfig` or - * `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + * Specified which products may be included in results. Uses same filter as + * boost. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlFilterAction : GTLRObject /** - * Output only. Whether the NotebookLM Corpus is ready to be used. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmNotEnabled - * The NotebookLM is not enabled. (Value: "NOTEBOOK_LM_NOT_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmNotReady - * The NotebookLM is not ready. (Value: "NOTEBOOK_LM_NOT_READY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmReady - * The NotebookLM is ready to be used. (Value: "NOTEBOOK_LM_READY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_NotebooklmState_NotebookLmStateUnspecified - * The NotebookLM state is unknown. (Value: - * "NOTEBOOK_LM_STATE_UNSPECIFIED") + * Required. Specifies which data store's documents can be filtered by this + * control. Full data store name e.g. + * projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ -@property(nonatomic, copy, nullable) NSString *notebooklmState; +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * Optional. Single-regional CMEKs that are required for some VAIS features. + * Required. A filter to apply on the matching condition results. Required + * Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order + * Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is + * thrown. */ -@property(nonatomic, strong, nullable) NSArray *singleRegionKeys; +@property(nonatomic, copy, nullable) NSString *filter; + +@end + /** - * Output only. The states of the CmekConfig. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Active - * The CmekConfig can be used with DataStores. (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_ActiveRotating - * The KMS key version is being rotated. (Value: "ACTIVE_ROTATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Creating - * The CmekConfig is creating. (Value: "CREATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleted - * The KMS key is soft deleted. Some cleanup policy will eventually be - * applied. (Value: "DELETED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_DeleteFailed - * The CmekConfig deletion process failed. (Value: "DELETE_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Deleting - * The CmekConfig is deleting. (Value: "DELETING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_KeyIssue - * The CmekConfig is unavailable, most likely due to the KMS Key being - * revoked. (Value: "KEY_ISSUE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_StateUnspecified - * The CmekConfig state is unknown. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig_State_Unusable - * The CmekConfig is not usable, most likely due to some internal issue. - * (Value: "UNUSABLE") + * Promote certain links based on some trigger queries. Example: Promote shoe + * store link when searching for `shoe` keyword. The link can be outside of + * associated data store. */ -@property(nonatomic, copy, nullable) NSString *state; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlPromoteAction : GTLRObject + +/** Required. Data store with which this promotion is attached to. */ +@property(nonatomic, copy, nullable) NSString *dataStore; + +/** Required. Promotion attached to this action. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchLinkPromotion *searchLinkPromotion; @end /** - * Defines circumstances to be checked before allowing a behavior + * Redirects a shopper to the provided URI. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCondition : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlRedirectAction : GTLRObject /** - * Range of time(s) specifying when condition is active. Maximum of 10 time - * ranges. + * Required. The URI to which the shopper will be redirected. Required. URI + * must have length equal or less than 2000 characters. Otherwise an INVALID + * ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSArray *activeTimeRange; +@property(nonatomic, copy, nullable) NSString *redirectUri; + +@end + /** - * Optional. Query regex to match the whole search query. Cannot be set when - * Condition.query_terms is set. Only supported for Basic Site Search promotion - * serving controls. + * Creates a set of terms that will act as synonyms of one another. Example: + * "happy" will also be considered as "glad", "glad" will also be considered as + * "happy". */ -@property(nonatomic, copy, nullable) NSString *queryRegex; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlSynonymsAction : GTLRObject /** - * Search only A list of terms to match the query on. Cannot be set when - * Condition.query_regex is set. Maximum of 10 query terms. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at + * least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSArray *queryTerms; +@property(nonatomic, strong, nullable) NSArray *synonyms; @end /** - * Matcher for search request query + * The historical crawl rate timeseries data, used for monitoring. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionQueryTerm : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries : GTLRObject + +/** The QPS of the crawl rate. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries *qpsTimeSeries; + +@end + /** - * Whether the search query needs to exactly match the query term. - * - * Uses NSNumber of boolValue. + * Metadata related to the progress of the DataStoreService.CreateDataStore + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) NSNumber *fullMatch; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The specific query value to match against Must be lowercase, must be UTF-8. - * Can have at most 3 space separated terms if full_match is true. Cannot be an - * empty string. Maximum length of 5000 characters. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *value; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Used for time-dependent conditions. + * Metadata related to the progress of the EngineService.CreateEngine + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaConditionTimeRange : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateEngineMetadata : GTLRObject -/** End of time range. Range is inclusive. Must be in the future. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** Start of time range. Range is inclusive. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Defines a conditioned behavior to employ during serving. Must be attached to - * a ServingConfig to be considered at serving time. Permitted actions - * dependent on `SolutionType`. + * Metadata for EvaluationService.CreateEvaluation method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata : GTLRObject +@end + /** - * Output only. List of all ServingConfig IDs this control is attached to. May - * take up to 10 minutes to update after changes. + * Metadata for Create Schema LRO. */ -@property(nonatomic, strong, nullable) NSArray *associatedServingConfigIds; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata : GTLRObject -/** Defines a boost-type control */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostAction *boostAction; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Determines when the associated action will trigger. Omit to always apply the - * action. Currently only a single condition may be specified. Otherwise an - * INVALID ARGUMENT error is thrown. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSArray *conditions; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Required. Human readable name. The identifier used in UI views. Must be - * UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID - * ARGUMENT error is thrown. + * Metadata related to the progress of the + * SiteSearchEngineService.CreateSitemap operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata : GTLRObject -/** Defines a filter-type control Currently not supported by Recommendation */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlFilterAction *filterAction; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Immutable. Fully qualified name `projects/ * /locations/global/dataStore/ * - * /controls/ *` + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** Promote certain links based on predefined trigger queries. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlPromoteAction *promoteAction; +@end -/** Defines a redirect-type control. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlRedirectAction *redirectAction; /** - * Required. Immutable. What solution the control belongs to. Must be - * compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is - * thrown. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeChat - * Used for use cases related to the Generative AI agent. (Value: - * "SOLUTION_TYPE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeGenerativeChat - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled - * with `SOLUTION_TYPE_CHAT` solution. (Value: - * "SOLUTION_TYPE_GENERATIVE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeRecommendation - * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeSearch - * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControl_SolutionType_SolutionTypeUnspecified - * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") + * Metadata related to the progress of the + * SiteSearchEngineService.CreateTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *solutionType; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata : GTLRObject -/** Treats a group of terms as synonyms of one another. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlSynonymsAction *synonymsAction; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Specifies the use case for the control. Affects what condition fields can be - * set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case - * per control. Must be set when solution_type is - * SolutionType.SOLUTION_TYPE_SEARCH. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSArray *useCases; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Adjusts order of products in returned list. + * DataStore captures global settings and configs at the DataStore level. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore : GTLRObject /** - * Strength of the boost, which should be in [-1, 1]. Negative boost means - * demotion. Default is 0.0 (No-op). + * Immutable. Whether data in the DataStore has ACL information. If set to + * `true`, the source data must have ACL. ACL will be ingested when data is + * ingested by DocumentService.ImportDocuments methods. When ACL is enabled for + * the DataStore, Document can't be accessed by calling + * DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL + * is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` + * content config. * - * Uses NSNumber of floatValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *boost GTLR_DEPRECATED; +@property(nonatomic, strong, nullable) NSNumber *aclEnabled; + +/** Optional. Configuration for advanced site search. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig *advancedSiteSearchConfig; + +/** Output only. Data size estimation for billing. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation *billingEstimation; + +/** Output only. CMEK-related information for the DataStore. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig *cmekConfig; /** - * Required. Specifies which data store's documents can be boosted by this - * control. Full data store name e.g. - * projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * Optional. Configuration for configurable billing approach. See + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified + * Default value. For Spark and non-Spark non-configurable billing + * approach. (Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding + * Use the consumption pay-as-you-go billing for embedding storage + * add-on. (Value: "CONFIGURABLE_CONSUMPTION_EMBEDDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore + * Use the subscription base + overage billing for indexing core for non + * embedding storage. (Value: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE") */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@property(nonatomic, copy, nullable) NSString *configurableBillingApproach; /** - * Required. Specifies which products to apply the boost to. If no filter is - * provided all products will be boosted (No-op). Syntax documentation: - * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 - * characters. Otherwise an INVALID ARGUMENT error is thrown. + * Immutable. The content config of the data store. If this field is unset, the + * server behavior defaults to ContentConfig.NO_CONTENT. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_ContentConfigUnspecified + * Default value. (Value: "CONTENT_CONFIG_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_ContentRequired + * Only contains documents with Document.content. (Value: + * "CONTENT_REQUIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_GoogleWorkspace + * The data store is used for workspace search. Details of workspace data + * store are specified in the WorkspaceConfig. (Value: + * "GOOGLE_WORKSPACE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_NoContent + * Only contains documents without any Document.content. (Value: + * "NO_CONTENT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_PublicWebsite + * The data store is used for public website search. (Value: + * "PUBLIC_WEBSITE") */ -@property(nonatomic, copy, nullable) NSString *filter; +@property(nonatomic, copy, nullable) NSString *contentConfig; + +/** Output only. Timestamp the DataStore was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost - * means demotion. Default is 0.0 (No-op). - * - * Uses NSNumber of floatValue. + * Output only. The id of the default Schema associated to this data store. */ -@property(nonatomic, strong, nullable) NSNumber *fixedBoost; +@property(nonatomic, copy, nullable) NSString *defaultSchemaId; /** - * Optional. Complex specification for custom ranking based on customer defined - * attribute value. + * Required. The data store display name. This field must be a UTF-8 encoded + * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT + * error is returned. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec *interpolationBoostSpec; +@property(nonatomic, copy, nullable) NSString *displayName; -@end +/** Configuration for Document understanding and enrichment. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig *documentProcessingConfig; +/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig *healthcareFhirConfig; /** - * Specification for custom ranking based on customer specified attribute - * value. It provides more controls for customized ranking than the simple - * (condition, boost) combination above. + * Immutable. The fully qualified resource name of the associated + * IdentityMappingStore. This field can only be set for acl_enabled DataStores + * with `THIRD_PARTY` or `GSUITE` IdP. Format: + * `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *identityMappingStore; /** - * Optional. The attribute type to be used to determine the boost amount. The - * attribute value can be derived from the field value of the specified - * field_name. In the case of numerical it is straightforward i.e. - * attribute_value = numerical_field_value. In the case of freshness however, - * attribute_value = (time.now() - datetime_field_value). + * Immutable. The industry vertical that the data store registers. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_AttributeType_AttributeTypeUnspecified - * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_AttributeType_Freshness - * For the freshness use case the attribute value will be the duration - * between the current time and the date in the datetime field specified. - * The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: - * "FRESHNESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_AttributeType_Numerical - * The value of the numerical field will be used to dynamically update - * the boost amount. In this case, the attribute_value (the x value) of - * the control point will be the actual value of the numerical field for - * which the boost_amount is specified. (Value: "NUMERICAL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_Generic + * The generic vertical for documents that are not specific to any + * industry vertical. (Value: "GENERIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_HealthcareFhir + * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_IndustryVerticalUnspecified + * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_Media + * The media industry vertical. (Value: "MEDIA") */ -@property(nonatomic, copy, nullable) NSString *attributeType; +@property(nonatomic, copy, nullable) NSString *industryVertical; /** - * Optional. The control points used to define the curve. The monotonic - * function (defined through the interpolation_type above) passes through the - * control points listed here. + * Optional. If set, this DataStore is an Infobot FAQ DataStore. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *controlPoints; +@property(nonatomic, strong, nullable) NSNumber *isInfobotFaqDataStore; /** - * Optional. The name of the field whose value will be used to determine the - * boost amount. + * Input only. The KMS key to be used to protect this DataStore at creation + * time. Must be set for requests that need to comply with CMEK Org Policy + * protections. If this field is set and processed successfully, the DataStore + * will be protected by the KMS key, as indicated in the cmek_config field. */ -@property(nonatomic, copy, nullable) NSString *fieldName; - -/** - * Optional. The interpolation type to be applied to connect the control points - * listed below. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified - * Interpolation type is unspecified. In this case, it defaults to - * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec_InterpolationType_Linear - * Piecewise linear interpolation will be applied. (Value: "LINEAR") +@property(nonatomic, copy, nullable) NSString *kmsKeyName; + +/** Language info for DataStore. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLanguageInfo *languageInfo; + +/** + * Immutable. Identifier. The full resource name of the data store. Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + * This field must be a UTF-8 encoded string with a length limit of 1024 + * characters. */ -@property(nonatomic, copy, nullable) NSString *interpolationType; +@property(nonatomic, copy, nullable) NSString *name; -@end +/** Optional. Configuration for Natural Language Query Understanding. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig *naturalLanguageQueryUnderstandingConfig; +/** Optional. Stores serving config at DataStore level. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore *servingConfigDataStore; /** - * The control points used to define the curve. The curve defined through these - * control points can only be monotonically increasing or decreasing(constant - * values are acceptable). + * The solutions that the data store enrolls. Available solutions for each + * industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and + * `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is + * automatically enrolled. Other solutions cannot be enrolled. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint : GTLRObject +@property(nonatomic, strong, nullable) NSArray *solutionTypes; /** - * Optional. Can be one of: 1. The numerical field value. 2. The duration spec - * for freshness: The value must be formatted as an XSD `dayTimeDuration` value - * (a restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. + * The start schema to use for this DataStore when provisioning it. If unset, a + * default vertical specialized schema will be used. This field is only used by + * CreateDataStore API, and will be ignored if used in other APIs. This field + * will be omitted from all API responses including CreateDataStore API. To + * retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. + * The provided schema will be validated against certain rules on schema. Learn + * more from [this + * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ -@property(nonatomic, copy, nullable) NSString *attributeValue; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema *startingSchema; /** - * Optional. The value between -1 to 1 by which to boost the score if the - * attribute_value evaluates to the value specified above. - * - * Uses NSNumber of floatValue. + * Config to store data store type configuration for workspace data. This must + * be set when DataStore.content_config is set as + * DataStore.ContentConfig.GOOGLE_WORKSPACE. */ -@property(nonatomic, strong, nullable) NSNumber *boostAmount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig *workspaceConfig; @end /** - * Specified which products may be included in results. Uses same filter as - * boost. + * Estimation of data size per data store. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlFilterAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation : GTLRObject /** - * Required. Specifies which data store's documents can be filtered by this - * control. Full data store name e.g. - * projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * Data size for structured data in terms of bytes. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@property(nonatomic, strong, nullable) NSNumber *structuredDataSize; + +/** Last updated timestamp for structured data. */ +@property(nonatomic, strong, nullable) GTLRDateTime *structuredDataUpdateTime; /** - * Required. A filter to apply on the matching condition results. Required - * Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order - * Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is - * thrown. + * Data size for unstructured data in terms of bytes. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *filter; - -@end +@property(nonatomic, strong, nullable) NSNumber *unstructuredDataSize; +/** Last updated timestamp for unstructured data. */ +@property(nonatomic, strong, nullable) GTLRDateTime *unstructuredDataUpdateTime; /** - * Promote certain links based on some trigger queries. Example: Promote shoe - * store link when searching for `shoe` keyword. The link can be outside of - * associated data store. + * Data size for websites in terms of bytes. + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlPromoteAction : GTLRObject - -/** Required. Data store with which this promotion is attached to. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@property(nonatomic, strong, nullable) NSNumber *websiteDataSize; -/** Required. Promotion attached to this action. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchLinkPromotion *searchLinkPromotion; +/** Last updated timestamp for websites. */ +@property(nonatomic, strong, nullable) GTLRDateTime *websiteDataUpdateTime; @end /** - * Redirects a shopper to the provided URI. + * Stores information regarding the serving configurations at DataStore level. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlRedirectAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore : GTLRObject /** - * Required. The URI to which the shopper will be redirected. Required. URI - * must have length equal or less than 2000 characters. Otherwise an INVALID - * ARGUMENT error is thrown. + * Optional. If set true, the DataStore will not be available for serving + * search requests. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *redirectUri; +@property(nonatomic, strong, nullable) NSNumber *disabledForServing; @end /** - * Creates a set of terms that will act as synonyms of one another. Example: - * "happy" will also be considered as "glad", "glad" will also be considered as - * "happy". + * The historical dedicated crawl rate timeseries data, used for monitoring. + * Dedicated crawl is used by Vertex AI to crawl the user's website when + * dedicate crawl is set. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaControlSynonymsAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries : GTLRObject + +/** Vertex AI's error rate time series of auto-refresh dedicated crawl. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *autoRefreshCrawlErrorRate; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at - * least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the + * crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the + * crawl rate is for best effort use cases like refreshing urls periodically. */ -@property(nonatomic, strong, nullable) NSArray *synonyms; - -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *autoRefreshCrawlRate; +/** Vertex AI's error rate time series of user triggered dedicated crawl. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *userTriggeredCrawlErrorRate; /** - * The historical crawl rate timeseries data, used for monitoring. + * Vertex AI's dedicated crawl rate time series of user triggered crawl, which + * is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and + * user triggered crawl rate is for deterministic use cases like crawling urls + * or sitemaps specified by users. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries : GTLRObject - -/** The QPS of the crawl rate. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleMonitoringV3TimeSeries *qpsTimeSeries; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *userTriggeredCrawlRate; @end /** - * Metadata related to the progress of the DataStoreService.CreateDataStore + * Metadata related to the progress of the DataStoreService.DeleteDataStore * operation. This will be returned by the * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -18498,11 +21070,11 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Metadata related to the progress of the EngineService.CreateEngine + * Metadata related to the progress of the EngineService.DeleteEngine * operation. This will be returned by the * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateEngineMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -18517,16 +21089,28 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Metadata for EvaluationService.CreateEvaluation method. + * Metadata related to the progress of the + * IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will + * be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + @end /** - * Metadata for Create Schema LRO. + * Metadata for DeleteSchema LRO. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -18542,10 +21126,10 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** * Metadata related to the progress of the - * SiteSearchEngineService.CreateSitemap operation. This will be returned by + * SiteSearchEngineService.DeleteSitemap operation. This will be returned by * the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateSitemapMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -18561,10 +21145,10 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** * Metadata related to the progress of the - * SiteSearchEngineService.CreateTargetSite operation. This will be returned by + * SiteSearchEngineService.DeleteTargetSite operation. This will be returned by * the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -18579,1384 +21163,1639 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * DataStore captures global settings and configs at the DataStore level. + * Metadata related to the progress of the + * SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Immutable. Whether data in the DataStore has ACL information. If set to - * `true`, the source data must have ACL. ACL will be ingested when data is - * ingested by DocumentService.ImportDocuments methods. When ACL is enabled for - * the DataStore, Document can't be accessed by calling - * DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL - * is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` - * content config. - * - * Uses NSNumber of boolValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *aclEnabled; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** Optional. Configuration for advanced site search. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig *advancedSiteSearchConfig; +@end -/** Output only. Data size estimation for billing. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation *billingEstimation; -/** Output only. CMEK-related information for the DataStore. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCmekConfig *cmekConfig; +/** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch + * method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse : GTLRObject +@end + /** - * Immutable. The content config of the data store. If this field is unset, the - * server behavior defaults to ContentConfig.NO_CONTENT. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_ContentConfigUnspecified - * Default value. (Value: "CONTENT_CONFIG_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_ContentRequired - * Only contains documents with Document.content. (Value: - * "CONTENT_REQUIRED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_GoogleWorkspace - * The data store is used for workspace search. Details of workspace data - * store are specified in the WorkspaceConfig. (Value: - * "GOOGLE_WORKSPACE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_NoContent - * Only contains documents without any Document.content. (Value: - * "NO_CONTENT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_ContentConfig_PublicWebsite - * The data store is used for public website search. (Value: - * "PUBLIC_WEBSITE") + * A singleton resource of DataStore. If it's empty when DataStore is created + * and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the + * default parser will default to digital parser. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig : GTLRObject + +/** Whether chunking mode is enabled. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig *chunkingConfig; + +/** + * Configurations for default Document parser. If not specified, we will + * configure it as default DigitalParsingConfig, and the default parsing config + * will be applied to all file types for Document parsing. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig *defaultParsingConfig; + +/** + * The full resource name of the Document Processing Config. Format: `projects/ + * * /locations/ * /collections/ * /dataStores/ * /documentProcessingConfig`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Map from file type to override the default parsing configuration based on + * the file type. Supported keys: * `pdf`: Override parsing config for PDF + * files, either digital parsing, ocr parsing or layout parsing is supported. * + * `html`: Override parsing config for HTML files, only digital parsing and + * layout parsing are supported. * `docx`: Override parsing config for DOCX + * files, only digital parsing and layout parsing are supported. * `pptx`: + * Override parsing config for PPTX files, only digital parsing and layout + * parsing are supported. * `xlsm`: Override parsing config for XLSM files, + * only digital parsing and layout parsing are supported. * `xlsx`: Override + * parsing config for XLSX files, only digital parsing and layout parsing are + * supported. */ -@property(nonatomic, copy, nullable) NSString *contentConfig; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig_ParsingConfigOverrides *parsingConfigOverrides; + +@end -/** Output only. Timestamp the DataStore was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Output only. The id of the default Schema associated to this data store. + * Map from file type to override the default parsing configuration based on + * the file type. Supported keys: * `pdf`: Override parsing config for PDF + * files, either digital parsing, ocr parsing or layout parsing is supported. * + * `html`: Override parsing config for HTML files, only digital parsing and + * layout parsing are supported. * `docx`: Override parsing config for DOCX + * files, only digital parsing and layout parsing are supported. * `pptx`: + * Override parsing config for PPTX files, only digital parsing and layout + * parsing are supported. * `xlsm`: Override parsing config for XLSM files, + * only digital parsing and layout parsing are supported. * `xlsx`: Override + * parsing config for XLSX files, only digital parsing and layout parsing are + * supported. + * + * @note This class is documented as having more properties of + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig. + * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get + * the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *defaultSchemaId; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig_ParsingConfigOverrides : GTLRObject +@end + /** - * Required. The data store display name. This field must be a UTF-8 encoded - * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT - * error is returned. + * Configuration for chunking config. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig : GTLRObject -/** Configuration for Document understanding and enrichment. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig *documentProcessingConfig; +/** Configuration for the layout based chunking. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig *layoutBasedChunkingConfig; + +@end -/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig *healthcareFhirConfig; /** - * Immutable. The fully qualified resource name of the associated - * IdentityMappingStore. This field can only be set for acl_enabled DataStores - * with `THIRD_PARTY` or `GSUITE` IdP. Format: - * `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. + * Configuration for the layout based chunking. */ -@property(nonatomic, copy, nullable) NSString *identityMappingStore; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig : GTLRObject /** - * Immutable. The industry vertical that the data store registers. + * The token size limit for each chunk. Supported values: 100-500 (inclusive). + * Default value: 500. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_Generic - * The generic vertical for documents that are not specific to any - * industry vertical. (Value: "GENERIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_HealthcareFhir - * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_IndustryVerticalUnspecified - * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStore_IndustryVertical_Media - * The media industry vertical. (Value: "MEDIA") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *industryVertical; +@property(nonatomic, strong, nullable) NSNumber *chunkSize; /** - * Optional. If set, this DataStore is an Infobot FAQ DataStore. + * Whether to include appending different levels of headings to chunks from the + * middle of the document to prevent context loss. Default value: False. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *isInfobotFaqDataStore; +@property(nonatomic, strong, nullable) NSNumber *includeAncestorHeadings; -/** - * Input only. The KMS key to be used to protect this DataStore at creation - * time. Must be set for requests that need to comply with CMEK Org Policy - * protections. If this field is set and processed successfully, the DataStore - * will be protected by the KMS key, as indicated in the cmek_config field. - */ -@property(nonatomic, copy, nullable) NSString *kmsKeyName; +@end -/** Language info for DataStore. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLanguageInfo *languageInfo; /** - * Immutable. Identifier. The full resource name of the data store. Format: - * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - * This field must be a UTF-8 encoded string with a length limit of 1024 - * characters. + * Related configurations applied to a specific type of document parser. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig : GTLRObject -/** Optional. Configuration for Natural Language Query Understanding. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig *naturalLanguageQueryUnderstandingConfig; +/** Configurations applied to digital parser. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig *digitalParsingConfig; -/** Optional. Stores serving config at DataStore level. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore *servingConfigDataStore; +/** Configurations applied to layout parser. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig *layoutParsingConfig; /** - * The solutions that the data store enrolls. Available solutions for each - * industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and - * `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is - * automatically enrolled. Other solutions cannot be enrolled. + * Configurations applied to OCR parser. Currently it only applies to PDFs. */ -@property(nonatomic, strong, nullable) NSArray *solutionTypes; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig *ocrParsingConfig; + +@end -/** - * The start schema to use for this DataStore when provisioning it. If unset, a - * default vertical specialized schema will be used. This field is only used by - * CreateDataStore API, and will be ignored if used in other APIs. This field - * will be omitted from all API responses including CreateDataStore API. To - * retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. - * The provided schema will be validated against certain rules on schema. Learn - * more from [this - * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema *startingSchema; /** - * Config to store data store type configuration for workspace data. This must - * be set when DataStore.content_config is set as - * DataStore.ContentConfig.GOOGLE_WORKSPACE. + * The digital parsing configurations for documents. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig *workspaceConfig; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig : GTLRObject @end /** - * Estimation of data size per data store. + * The layout parsing configurations for documents. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig : GTLRObject /** - * Data size for structured data in terms of bytes. + * Optional. If true, the processed document will be made available for the + * GetProcessedDocument API. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *structuredDataSize; - -/** Last updated timestamp for structured data. */ -@property(nonatomic, strong, nullable) GTLRDateTime *structuredDataUpdateTime; +@property(nonatomic, strong, nullable) NSNumber *enableGetProcessedDocument; /** - * Data size for unstructured data in terms of bytes. + * Optional. If true, the LLM based annotation is added to the image during + * parsing. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *unstructuredDataSize; - -/** Last updated timestamp for unstructured data. */ -@property(nonatomic, strong, nullable) GTLRDateTime *unstructuredDataUpdateTime; +@property(nonatomic, strong, nullable) NSNumber *enableImageAnnotation; /** - * Data size for websites in terms of bytes. + * Optional. If true, the LLM based annotation is added to the table during + * parsing. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *websiteDataSize; +@property(nonatomic, strong, nullable) NSNumber *enableTableAnnotation; -/** Last updated timestamp for websites. */ -@property(nonatomic, strong, nullable) GTLRDateTime *websiteDataUpdateTime; +/** Optional. List of HTML classes to exclude from the parsed content. */ +@property(nonatomic, strong, nullable) NSArray *excludeHtmlClasses; + +/** Optional. List of HTML elements to exclude from the parsed content. */ +@property(nonatomic, strong, nullable) NSArray *excludeHtmlElements; + +/** Optional. List of HTML ids to exclude from the parsed content. */ +@property(nonatomic, strong, nullable) NSArray *excludeHtmlIds; + +/** + * Optional. Contains the required structure types to extract from the + * document. Supported values: * `shareholder-structure` + */ +@property(nonatomic, strong, nullable) NSArray *structuredContentTypes; @end /** - * Stores information regarding the serving configurations at DataStore level. + * The OCR parsing configurations for documents. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig : GTLRObject /** - * Optional. If set true, the DataStore will not be available for serving - * search requests. + * [DEPRECATED] This field is deprecated. To use the additional enhanced + * document elements processing, please switch to `layout_parsing_config`. + */ +@property(nonatomic, strong, nullable) NSArray *enhancedDocumentElements GTLR_DEPRECATED; + +/** + * If true, will use native text instead of OCR text on pages containing native + * text. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *disabledForServing; +@property(nonatomic, strong, nullable) NSNumber *useNativeText; @end /** - * The historical dedicated crawl rate timeseries data, used for monitoring. - * Dedicated crawl is used by Vertex AI to crawl the user's website when - * dedicate crawl is set. + * Metadata related to the progress of the + * SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata : GTLRObject -/** Vertex AI's error rate time series of auto-refresh dedicated crawl. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *autoRefreshCrawlErrorRate; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Vertex AI's dedicated crawl rate time series of auto-refresh, which is the - * crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the - * crawl rate is for best effort use cases like refreshing urls periodically. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *autoRefreshCrawlRate; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end -/** Vertex AI's error rate time series of user triggered dedicated crawl. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *userTriggeredCrawlErrorRate; /** - * Vertex AI's dedicated crawl rate time series of user triggered crawl, which - * is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and - * user triggered crawl rate is for deterministic use cases like crawling urls - * or sitemaps specified by users. + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch + * method. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *userTriggeredCrawlRate; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse : GTLRObject @end /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Metadata that describes the training and serving parameters of an Engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Optional. Immutable. This the application type which this engine resource + * represents. NOTE: this is a new concept independ of existing industry + * vertical or solution type. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeIntranet + * App type for intranet search and Agentspace. (Value: + * "APP_TYPE_INTRANET") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeUnspecified + * All non specified apps. (Value: "APP_TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *appType; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Configurations for the Chat Engine. Only applicable if solution_type is + * SOLUTION_TYPE_CHAT. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig *chatEngineConfig; -@end +/** + * Output only. Additional information of the Chat Engine. Only applicable if + * solution_type is SOLUTION_TYPE_CHAT. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata *chatEngineMetadata; +/** Common config spec that specifies the metadata of the engine. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineCommonConfig *commonConfig; /** - * Metadata related to the progress of the EngineService.DeleteEngine - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Optional. Configuration for configurable billing approach. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled + * The billing approach follows configurations specified by customer. + * (Value: "CONFIGURABLE_BILLING_APPROACH_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified + * Default value. For Spark and non-Spark non-configurable billing + * approach. General pricing model. (Value: + * "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *configurableBillingApproach; -/** Operation create time. */ +/** Output only. Timestamp the Recommendation Engine was created at. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The data stores associated with this engine. For + * SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they + * can only associate with at most one data store. If solution_type is + * SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be + * associated here. Note that when used in CreateEngineRequest, one DataStore + * id must be provided as the system will use it for necessary initializations. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, strong, nullable) NSArray *dataStoreIds; /** - * Metadata related to the progress of the - * IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will - * be returned by the google.longrunning.Operation.metadata field. + * Optional. Whether to disable analytics for searches performed on this + * engine. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) NSNumber *disableAnalytics; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Required. The display name of the engine. Should be human readable. UTF-8 + * encoded string with limit of 1024 characters. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Metadata for DeleteSchema LRO. + * Optional. Feature config for the engine to opt in or opt out of features. + * Supported keys: * `*`: all features, if it's present, all other feature + * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * + * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * + * `people-search-org-chart` * `bi-directional-audio` * `feedback` * + * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * + * `disable-image-generation` * `disable-video-generation` * + * `disable-onedrive-upload` * `disable-talk-to-content` * + * `disable-google-drive-upload` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_Features *features; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The industry vertical that the engine registers. The restriction + * of the Engine industry vertical is based on DataStore: Vertical on Engine + * has to match vertical of the DataStore linked to the engine. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_Generic + * The generic vertical for documents that are not specific to any + * industry vertical. (Value: "GENERIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_HealthcareFhir + * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_IndustryVerticalUnspecified + * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_Media + * The media industry vertical. (Value: "MEDIA") */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, copy, nullable) NSString *industryVertical; /** - * Metadata related to the progress of the - * SiteSearchEngineService.DeleteSitemap operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Configurations for the Media Engine. Only applicable on the data stores with + * solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA + * vertical. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteSitemapMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig *mediaRecommendationEngineConfig; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Immutable. Identifier. The fully qualified resource name of the engine. This + * field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Format: + * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + * engine should be 1-63 characters, and valid characters are /a-z0-9* /. + * Otherwise, an INVALID_ARGUMENT error is returned. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, copy, nullable) NSString *name; /** - * Metadata related to the progress of the - * SiteSearchEngineService.DeleteTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Configurations for the Search Engine. Only applicable if solution_type is + * SOLUTION_TYPE_SEARCH. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig *searchEngineConfig; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Required. The solutions of the engine. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeChat + * Used for use cases related to the Generative AI agent. (Value: + * "SOLUTION_TYPE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeGenerativeChat + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled + * with `SOLUTION_TYPE_CHAT` solution. (Value: + * "SOLUTION_TYPE_GENERATIVE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeRecommendation + * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeSearch + * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeUnspecified + * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") */ +@property(nonatomic, copy, nullable) NSString *solutionType; + +/** Output only. Timestamp the Recommendation Engine was last updated. */ @property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * Optional. Feature config for the engine to opt in or opt out of features. + * Supported keys: * `*`: all features, if it's present, all other feature + * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * + * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * + * `people-search-org-chart` * `bi-directional-audio` * `feedback` * + * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * + * `disable-image-generation` * `disable-video-generation` * + * `disable-onedrive-upload` * `disable-talk-to-content` * + * `disable-google-drive-upload` + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_Features : GTLRObject +@end -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Configurations for a Chat Engine. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig : GTLRObject -@end +/** + * The configurationt generate the Dialogflow agent that is associated to this + * Engine. Note that these configurations are one-time consumed by and passed + * to Dialogflow service. It means they cannot be retrieved using + * EngineService.GetEngine or EngineService.ListEngines API after engine + * creation. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig *agentCreationConfig; +/** + * Optional. If the flag set to true, we allow the agent and engine are in + * different locations, otherwise the agent and engine are required to be in + * the same location. The flag is set to false by default. Note that the + * `allow_cross_region` are one-time consumed by and passed to + * EngineService.CreateEngine. It means they cannot be retrieved using + * EngineService.GetEngine or EngineService.ListEngines API after engine + * creation. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *allowCrossRegion; /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch - * method. + * The resource name of an exist Dialogflow agent to link to this Chat Engine. + * Customers can either provide `agent_creation_config` to create agent or + * provide an agent name that links the agent with the Chat engine. Format: + * `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are + * one-time consumed by and passed to Dialogflow service. It means they cannot + * be retrieved using EngineService.GetEngine or EngineService.ListEngines API + * after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual + * agent association after Engine is created. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse : GTLRObject +@property(nonatomic, copy, nullable) NSString *dialogflowAgentToLink; + @end /** - * A singleton resource of DataStore. If it's empty when DataStore is created - * and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the - * default parser will default to digital parser. + * Configurations for generating a Dialogflow agent. Note that these + * configurations are one-time consumed by and passed to Dialogflow service. It + * means they cannot be retrieved using EngineService.GetEngine or + * EngineService.ListEngines API after engine creation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig : GTLRObject - -/** Whether chunking mode is enabled. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig *chunkingConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig : GTLRObject /** - * Configurations for default Document parser. If not specified, we will - * configure it as default DigitalParsingConfig, and the default parsing config - * will be applied to all file types for Document parsing. + * Name of the company, organization or other entity that the agent represents. + * Used for knowledge connector LLM prompt and for knowledge search. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig *defaultParsingConfig; +@property(nonatomic, copy, nullable) NSString *business; /** - * The full resource name of the Document Processing Config. Format: `projects/ - * * /locations/ * /collections/ * /dataStores/ * /documentProcessingConfig`. + * Required. The default language of the agent as a language tag. See [Language + * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a + * list of the currently supported language codes. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, copy, nullable) NSString *defaultLanguageCode; /** - * Map from file type to override the default parsing configuration based on - * the file type. Supported keys: * `pdf`: Override parsing config for PDF - * files, either digital parsing, ocr parsing or layout parsing is supported. * - * `html`: Override parsing config for HTML files, only digital parsing and - * layout parsing are supported. * `docx`: Override parsing config for DOCX - * files, only digital parsing and layout parsing are supported. * `pptx`: - * Override parsing config for PPTX files, only digital parsing and layout - * parsing are supported. * `xlsm`: Override parsing config for XLSM files, - * only digital parsing and layout parsing are supported. * `xlsx`: Override - * parsing config for XLSX files, only digital parsing and layout parsing are - * supported. + * Agent location for Agent creation, supported values: global/us/eu. If not + * provided, us Engine will create Agent using us-central-1 by default; eu + * Engine will create Agent using eu-west-1 by default. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig_ParsingConfigOverrides *parsingConfigOverrides; - -@end - +@property(nonatomic, copy, nullable) NSString *location; /** - * Map from file type to override the default parsing configuration based on - * the file type. Supported keys: * `pdf`: Override parsing config for PDF - * files, either digital parsing, ocr parsing or layout parsing is supported. * - * `html`: Override parsing config for HTML files, only digital parsing and - * layout parsing are supported. * `docx`: Override parsing config for DOCX - * files, only digital parsing and layout parsing are supported. * `pptx`: - * Override parsing config for PPTX files, only digital parsing and layout - * parsing are supported. * `xlsm`: Override parsing config for XLSM files, - * only digital parsing and layout parsing are supported. * `xlsx`: Override - * parsing config for XLSX files, only digital parsing and layout parsing are - * supported. - * - * @note This class is documented as having more properties of - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig. - * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get - * the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Required. The time zone of the agent from the [time zone + * database](https://www.iana.org/time-zones), e.g., America/New_York, + * Europe/Paris. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig_ParsingConfigOverrides : GTLRObject +@property(nonatomic, copy, nullable) NSString *timeZone; + @end /** - * Configuration for chunking config. + * Additional information of a Chat Engine. Fields in this message are output + * only. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata : GTLRObject -/** Configuration for the layout based chunking. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig *layoutBasedChunkingConfig; +/** + * The resource name of a Dialogflow agent, that this Chat Engine refers to. + * Format: `projects//locations//agents/`. + */ +@property(nonatomic, copy, nullable) NSString *dialogflowAgent; @end /** - * Configuration for the layout based chunking. + * Common configurations for an Engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineCommonConfig : GTLRObject /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). - * Default value: 500. - * - * Uses NSNumber of intValue. + * The name of the company, business or entity that is associated with the + * engine. Setting this may help improve LLM related features. */ -@property(nonatomic, strong, nullable) NSNumber *chunkSize; +@property(nonatomic, copy, nullable) NSString *companyName; + +@end + /** - * Whether to include appending different levels of headings to chunks from the - * middle of the document to prevent context loss. Default value: False. - * - * Uses NSNumber of boolValue. + * Additional config specs for a Media Recommendation engine. */ -@property(nonatomic, strong, nullable) NSNumber *includeAncestorHeadings; - -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig : GTLRObject +/** Optional. Additional engine features config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig *engineFeaturesConfig; /** - * Related configurations applied to a specific type of document parser. + * The optimization objective. e.g., `cvr`. This field together with + * optimization_objective describe engine metadata to use to control engine + * training and serving. Currently supported values: `ctr`, `cvr`. If not + * specified, we choose default based on engine type. Default depends on type + * of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => + * `ctr` */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *optimizationObjective; -/** Configurations applied to digital parser. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig *digitalParsingConfig; +/** + * Name and value of the custom threshold for cvr optimization_objective. For + * target_field `watch-time`, target_field_value must be an integer value + * indicating the media progress time in seconds between (0, 86400] (excludes + * 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the + * target_field_value must be a valid float value between (0, 1.0] (excludes 0, + * includes 1.0) (e.g., 0.5). + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig *optimizationObjectiveConfig; -/** Configurations applied to layout parser. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig *layoutParsingConfig; +/** + * The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). + * Since part of the cost of running the service is frequency of training - + * this can be used to determine when to train engine in order to control cost. + * If not specified: the default value for `CreateEngine` method is `TRAINING`. + * The default value for `UpdateEngine` method is to keep the state the same as + * before. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig_TrainingState_Paused + * The engine training is paused. (Value: "PAUSED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig_TrainingState_Training + * The engine is training. (Value: "TRAINING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig_TrainingState_TrainingStateUnspecified + * Unspecified training state. (Value: "TRAINING_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *trainingState; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * Required. The type of engine. e.g., `recommended-for-you`. This field + * together with optimization_objective describe engine metadata to use to + * control engine training and serving. Currently supported values: + * `recommended-for-you`, `others-you-may-like`, `more-like-this`, + * `most-popular-items`. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig *ocrParsingConfig; +@property(nonatomic, copy, nullable) NSString *type; @end /** - * The digital parsing configurations for documents. + * More feature configs of the selected engine type. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig : GTLRObject + +/** Most popular engine feature config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig *mostPopularConfig; + +/** Recommended for you engine feature config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig *recommendedForYouConfig; + @end /** - * The layout parsing configurations for documents. + * Feature configurations that are required for creating a Most Popular engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig : GTLRObject /** - * Optional. If true, the processed document will be made available for the - * GetProcessedDocument API. + * The time window of which the engine is queried at training and prediction + * time. Positive integers only. The value translates to the last X days of + * events. Currently required for the `most-popular-items` engine. * - * Uses NSNumber of boolValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *enableGetProcessedDocument; +@property(nonatomic, strong, nullable) NSNumber *timeWindowDays; + +@end + /** - * Optional. If true, the LLM based annotation is added to the image during - * parsing. - * - * Uses NSNumber of boolValue. + * Custom threshold for `cvr` optimization_objective. */ -@property(nonatomic, strong, nullable) NSNumber *enableImageAnnotation; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig : GTLRObject /** - * Optional. If true, the LLM based annotation is added to the table during - * parsing. + * Required. The name of the field to target. Currently supported values: + * `watch-percentage`, `watch-time`. + */ +@property(nonatomic, copy, nullable) NSString *targetField; + +/** + * Required. The threshold to be applied to the target (e.g., 0.5). * - * Uses NSNumber of boolValue. + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *enableTableAnnotation; +@property(nonatomic, strong, nullable) NSNumber *targetFieldValueFloat; -/** Optional. List of HTML classes to exclude from the parsed content. */ -@property(nonatomic, strong, nullable) NSArray *excludeHtmlClasses; +@end -/** Optional. List of HTML elements to exclude from the parsed content. */ -@property(nonatomic, strong, nullable) NSArray *excludeHtmlElements; -/** Optional. List of HTML ids to exclude from the parsed content. */ -@property(nonatomic, strong, nullable) NSArray *excludeHtmlIds; +/** + * Additional feature configurations for creating a `recommended-for-you` + * engine. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig : GTLRObject /** - * Optional. Contains the required structure types to extract from the - * document. Supported values: * `shareholder-structure` + * The type of event with which the engine is queried at prediction time. If + * set to `generic`, only `view-item`, `media-play`,and `media-complete` will + * be used as `context-event` in engine training. If set to `view-home-page`, + * `view-home-page` will also be used as `context-events` in addition to + * `view-item`, `media-play`, and `media-complete`. Currently supported for the + * `recommended-for-you` engine. Currently supported values: `view-home-page`, + * `generic`. */ -@property(nonatomic, strong, nullable) NSArray *structuredContentTypes; +@property(nonatomic, copy, nullable) NSString *contextEventType; @end /** - * The OCR parsing configurations for documents. + * Configurations for a Search Engine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig : GTLRObject -/** - * [DEPRECATED] This field is deprecated. To use the additional enhanced - * document elements processing, please switch to `layout_parsing_config`. - */ -@property(nonatomic, strong, nullable) NSArray *enhancedDocumentElements GTLR_DEPRECATED; +/** The add-on that this search engine enables. */ +@property(nonatomic, strong, nullable) NSArray *searchAddOns; /** - * If true, will use native text instead of OCR text on pages containing native - * text. + * The search feature tier of this engine. Different tiers might have different + * pricing. To learn more, check the pricing documentation. Defaults to + * SearchTier.SEARCH_TIER_STANDARD if not specified. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig_SearchTier_SearchTierEnterprise + * Enterprise tier. (Value: "SEARCH_TIER_ENTERPRISE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig_SearchTier_SearchTierStandard + * Standard tier. (Value: "SEARCH_TIER_STANDARD") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig_SearchTier_SearchTierUnspecified + * Default value when the enum is unspecified. This is invalid to use. + * (Value: "SEARCH_TIER_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *useNativeText; +@property(nonatomic, copy, nullable) NSString *searchTier; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * An evaluation is a single execution (or run) of an evaluation process. It + * encapsulates the state of the evaluation and the resulting data. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation : GTLRObject -/** Operation create time. */ +/** Output only. Timestamp the Evaluation was created at. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Output only. Timestamp the Evaluation was completed at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; + /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Output only. The error that occurred during evaluation. Only populated when + * the evaluation's state is FAILED. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; -@end +/** + * Output only. A sample of errors encountered while processing the request. + */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** Required. The specification of the evaluation. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec *evaluationSpec; +/** + * Identifier. The full resource name of the Evaluation, in the format of + * `projects/{project}/locations/{location}/evaluations/{evaluation}`. This + * field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ +@property(nonatomic, copy, nullable) NSString *name; /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch - * method. + * Output only. The metrics produced by the evaluation, averaged across all + * SampleQuerys in the SampleQuerySet. Only populated when the evaluation's + * state is SUCCEEDED. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetrics *qualityMetrics; + +/** + * Output only. The state of the evaluation. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Failed + * The evaluation failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Pending + * The service is preparing to run the evaluation. (Value: "PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Running + * The evaluation is in progress. (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_StateUnspecified + * The evaluation is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Succeeded + * The evaluation completed successfully. (Value: "SUCCEEDED") + */ +@property(nonatomic, copy, nullable) NSString *state; + @end /** - * Metadata that describes the training and serving parameters of an Engine. + * Describes the specification of the evaluation. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec : GTLRObject + +/** Optional. The specification of the query set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec *querySetSpec; + +/** + * Required. The search request that is used to perform the evaluation. Only + * the following fields within SearchRequest are supported; if any other fields + * are provided, an UNSUPPORTED error will be returned: * + * SearchRequest.serving_config * SearchRequest.branch * + * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * + * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * + * SearchRequest.user_pseudo_id */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest *searchRequest; + +@end -/** - * Optional. Immutable. This the application type which this engine resource - * represents. NOTE: this is a new concept independ of existing industry - * vertical or solution type. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeIntranet - * App type for intranet search and Agentspace. (Value: - * "APP_TYPE_INTRANET") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_AppType_AppTypeUnspecified - * All non specified apps. (Value: "APP_TYPE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *appType; /** - * Configurations for the Chat Engine. Only applicable if solution_type is - * SOLUTION_TYPE_CHAT. + * Describes the specification of the query set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig *chatEngineConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec : GTLRObject /** - * Output only. Additional information of the Chat Engine. Only applicable if - * solution_type is SOLUTION_TYPE_CHAT. + * Optional. The full resource name of the SampleQuerySet used for the + * evaluation, in the format of + * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata *chatEngineMetadata; +@property(nonatomic, copy, nullable) NSString *sampleQuerySet; -/** Common config spec that specifies the metadata of the engine. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineCommonConfig *commonConfig; +@end -/** Output only. Timestamp the Recommendation Engine was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. The data stores associated with this engine. For - * SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they - * can only associate with at most one data store. If solution_type is - * SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be - * associated here. Note that when used in CreateEngineRequest, one DataStore - * id must be provided as the system will use it for necessary initializations. + * Config to data store for `HEALTHCARE_FHIR` vertical. */ -@property(nonatomic, strong, nullable) NSArray *dataStoreIds; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig : GTLRObject /** - * Optional. Whether to disable analytics for searches performed on this - * engine. + * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set + * to `true`, the predefined healthcare fhir schema can be extended for more + * customized searching and filtering. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *disableAnalytics; +@property(nonatomic, strong, nullable) NSNumber *enableConfigurableSchema; /** - * Required. The display name of the engine. Should be human readable. UTF-8 - * encoded string with limit of 1024 characters. + * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If + * set to `true`, the batch ingestion will be processed in a static indexing + * mode which is slower but more capable of handling larger volume. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@property(nonatomic, strong, nullable) NSNumber *enableStaticIndexingForBatchIngestion; + +@end + /** - * Optional. Feature config for the engine to opt in or opt out of features. - * Supported keys: * `*`: all features, if it's present, all other feature - * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * - * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * - * `people-search-org-chart` * `bi-directional-audio` * `feedback` * - * `session-sharing` * `personalization-memory` - Enables personalization based - * on user preferences. + * IdentityMappingEntry LongRunningOperation metadata for + * IdentityMappingStoreService.ImportIdentityMappings and + * IdentityMappingStoreService.PurgeIdentityMappings */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_Features *features; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata : GTLRObject /** - * Optional. The industry vertical that the engine registers. The restriction - * of the Engine industry vertical is based on DataStore: Vertical on Engine - * has to match vertical of the DataStore linked to the engine. + * The number of IdentityMappingEntries that failed to be processed. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_Generic - * The generic vertical for documents that are not specific to any - * industry vertical. (Value: "GENERIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_HealthcareFhir - * The healthcare FHIR vertical. (Value: "HEALTHCARE_FHIR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_IndustryVerticalUnspecified - * Value used when unset. (Value: "INDUSTRY_VERTICAL_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_IndustryVertical_Media - * The media industry vertical. (Value: "MEDIA") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *industryVertical; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * Configurations for the Media Engine. Only applicable on the data stores with - * solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA - * vertical. + * The number of IdentityMappingEntries that were successfully processed. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig *mediaRecommendationEngineConfig; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * Immutable. Identifier. The fully qualified resource name of the engine. This - * field must be a UTF-8 encoded string with a length limit of 1024 characters. - * Format: - * `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - * engine should be 1-63 characters, and valid characters are /a-z0-9* /. - * Otherwise, an INVALID_ARGUMENT error is returned. + * The total number of IdentityMappingEntries that were processed. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSNumber *totalCount; + +@end + /** - * Configurations for the Search Engine. Only applicable if solution_type is - * SOLUTION_TYPE_SEARCH. + * Identity Provider Config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig *searchEngineConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig : GTLRObject + +/** External Identity provider config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig *externalIdpConfig; /** - * Required. The solutions of the engine. + * Identity provider type configured. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeChat - * Used for use cases related to the Generative AI agent. (Value: - * "SOLUTION_TYPE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeGenerativeChat - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled - * with `SOLUTION_TYPE_CHAT` solution. (Value: - * "SOLUTION_TYPE_GENERATIVE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeRecommendation - * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeSearch - * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_SolutionType_SolutionTypeUnspecified - * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_Gsuite + * Google 1P provider. (Value: "GSUITE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_IdpTypeUnspecified + * Default value. ACL search not enabled. (Value: "IDP_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_ThirdParty + * Third party provider. (Value: "THIRD_PARTY") */ -@property(nonatomic, copy, nullable) NSString *solutionType; - -/** Output only. Timestamp the Recommendation Engine was last updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *idpType; @end /** - * Optional. Feature config for the engine to opt in or opt out of features. - * Supported keys: * `*`: all features, if it's present, all other feature - * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * - * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * - * `people-search-org-chart` * `bi-directional-audio` * `feedback` * - * `session-sharing` * `personalization-memory` - Enables personalization based - * on user preferences. - * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Third party IDP Config. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngine_Features : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig : GTLRObject + +/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */ +@property(nonatomic, copy, nullable) NSString *workforcePoolName; + @end /** - * Configurations for a Chat Engine. + * Metadata related to the progress of the ImportCompletionSuggestions + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The configurationt generate the Dialogflow agent that is associated to this - * Engine. Note that these configurations are one-time consumed by and passed - * to Dialogflow service. It means they cannot be retrieved using - * EngineService.GetEngine or EngineService.ListEngines API after engine - * creation. + * Count of CompletionSuggestions that failed to be imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig *agentCreationConfig; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * Optional. If the flag set to true, we allow the agent and engine are in - * different locations, otherwise the agent and engine are required to be in - * the same location. The flag is set to false by default. Note that the - * `allow_cross_region` are one-time consumed by and passed to - * EngineService.CreateEngine. It means they cannot be retrieved using - * EngineService.GetEngine or EngineService.ListEngines API after engine - * creation. + * Count of CompletionSuggestions successfully imported. * - * Uses NSNumber of boolValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *allowCrossRegion; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * The resource name of an exist Dialogflow agent to link to this Chat Engine. - * Customers can either provide `agent_creation_config` to create agent or - * provide an agent name that links the agent with the Chat engine. Format: - * `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are - * one-time consumed by and passed to Dialogflow service. It means they cannot - * be retrieved using EngineService.GetEngine or EngineService.ListEngines API - * after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual - * agent association after Engine is created. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *dialogflowAgentToLink; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Configurations for generating a Dialogflow agent. Note that these - * configurations are one-time consumed by and passed to Dialogflow service. It - * means they cannot be retrieved using EngineService.GetEngine or - * EngineService.ListEngines API after engine creation. + * Response of the CompletionService.ImportCompletionSuggestions method. If the + * long running operation is done, this message is returned by the + * google.longrunning.Operations.response field if the operation is successful. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse : GTLRObject + +/** The desired location of errors incurred during the Import. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +@end + /** - * Name of the company, organization or other entity that the agent represents. - * Used for knowledge connector LLM prompt and for knowledge search. + * Metadata related to the progress of the ImportDocuments operation. This is + * returned by the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *business; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Required. The default language of the agent as a language tag. See [Language - * Support](https://cloud.google.com/dialogflow/docs/reference/language) for a - * list of the currently supported language codes. + * Count of entries that encountered errors while processing. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *defaultLanguageCode; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * Agent location for Agent creation, supported values: global/us/eu. If not - * provided, us Engine will create Agent using us-central-1 by default; eu - * Engine will create Agent using eu-west-1 by default. + * Count of entries that were processed successfully. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *successCount; + +/** + * Total count of entries that were processed. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalCount; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *location; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Required. The time zone of the agent from the [time zone - * database](https://www.iana.org/time-zones), e.g., America/New_York, - * Europe/Paris. + * Response of the ImportDocumentsRequest. If the long running operation is + * done, then this message is returned by the + * google.longrunning.Operations.response field if the operation was + * successful. */ -@property(nonatomic, copy, nullable) NSString *timeZone; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportDocumentsResponse : GTLRObject + +/** Echoes the destination for the complete errors in the request if set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; @end /** - * Additional information of a Chat Engine. Fields in this message are output - * only. + * Configuration of destination for Import related errors. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig : GTLRObject /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. - * Format: `projects//locations//agents/`. + * Cloud Storage prefix for import errors. This must be an empty, existing + * Cloud Storage directory. Import errors are written to sharded files in this + * directory, one per line, as a JSON-encoded `google.rpc.Status` message. */ -@property(nonatomic, copy, nullable) NSString *dialogflowAgent; +@property(nonatomic, copy, nullable) NSString *gcsPrefix; @end /** - * Common configurations for an Engine. + * Response message for IdentityMappingStoreService.ImportIdentityMappings */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineCommonConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse : GTLRObject -/** - * The name of the company, business or entity that is associated with the - * engine. Setting this may help improve LLM related features. - */ -@property(nonatomic, copy, nullable) NSString *companyName; +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; @end /** - * Additional config specs for a Media Recommendation engine. + * Metadata related to the progress of the ImportSampleQueries operation. This + * will be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata : GTLRObject -/** Optional. Additional engine features config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig *engineFeaturesConfig; +/** ImportSampleQueries operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The optimization objective. e.g., `cvr`. This field together with - * optimization_objective describe engine metadata to use to control engine - * training and serving. Currently supported values: `ctr`, `cvr`. If not - * specified, we choose default based on engine type. Default depends on type - * of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => - * `ctr` + * Count of SampleQuerys that failed to be imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *optimizationObjective; +@property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * Name and value of the custom threshold for cvr optimization_objective. For - * target_field `watch-time`, target_field_value must be an integer value - * indicating the media progress time in seconds between (0, 86400] (excludes - * 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the - * target_field_value must be a valid float value between (0, 1.0] (excludes 0, - * includes 1.0) (e.g., 0.5). + * Count of SampleQuerys successfully imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig *optimizationObjectiveConfig; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). - * Since part of the cost of running the service is frequency of training - - * this can be used to determine when to train engine in order to control cost. - * If not specified: the default value for `CreateEngine` method is `TRAINING`. - * The default value for `UpdateEngine` method is to keep the state the same as - * before. + * Total count of SampleQuerys that were processed. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig_TrainingState_Paused - * The engine training is paused. (Value: "PAUSED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig_TrainingState_Training - * The engine is training. (Value: "TRAINING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig_TrainingState_TrainingStateUnspecified - * Unspecified training state. (Value: "TRAINING_STATE_UNSPECIFIED") + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *trainingState; +@property(nonatomic, strong, nullable) NSNumber *totalCount; /** - * Required. The type of engine. e.g., `recommended-for-you`. This field - * together with optimization_objective describe engine metadata to use to - * control engine training and serving. Currently supported values: - * `recommended-for-you`, `others-you-may-like`, `more-like-this`, - * `most-popular-items`. + * ImportSampleQueries operation last update time. If the operation is done, + * this is also the finish time. */ -@property(nonatomic, copy, nullable) NSString *type; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * More feature configs of the selected engine type. + * Response of the SampleQueryService.ImportSampleQueries method. If the long + * running operation is done, this message is returned by the + * google.longrunning.Operations.response field if the operation is successful. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse : GTLRObject -/** Most popular engine feature config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig *mostPopularConfig; +/** The desired location of errors incurred during the Import. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; -/** Recommended for you engine feature config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig *recommendedForYouConfig; +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; @end /** - * Feature configurations that are required for creating a Most Popular engine. + * Metadata related to the progress of the ImportSuggestionDenyListEntries + * operation. This is returned by the google.longrunning.Operation.metadata + * field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The time window of which the engine is queried at training and prediction - * time. Positive integers only. The value translates to the last X days of - * events. Currently required for the `most-popular-items` engine. - * - * Uses NSNumber of longLongValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *timeWindowDays; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Custom threshold for `cvr` optimization_objective. + * Response message for CompletionService.ImportSuggestionDenyListEntries + * method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse : GTLRObject + +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * Required. The name of the field to target. Currently supported values: - * `watch-percentage`, `watch-time`. + * Count of deny list entries that failed to be imported. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *targetField; +@property(nonatomic, strong, nullable) NSNumber *failedEntriesCount; /** - * Required. The threshold to be applied to the target (e.g., 0.5). + * Count of deny list entries successfully imported. * - * Uses NSNumber of floatValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *targetFieldValueFloat; +@property(nonatomic, strong, nullable) NSNumber *importedEntriesCount; @end /** - * Additional feature configurations for creating a `recommended-for-you` - * engine. + * Metadata related to the progress of the Import operation. This is returned + * by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The type of event with which the engine is queried at prediction time. If - * set to `generic`, only `view-item`, `media-play`,and `media-complete` will - * be used as `context-event` in engine training. If set to `view-home-page`, - * `view-home-page` will also be used as `context-events` in addition to - * `view-item`, `media-play`, and `media-complete`. Currently supported for the - * `recommended-for-you` engine. Currently supported values: `view-home-page`, - * `generic`. + * Count of entries that encountered errors while processing. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, copy, nullable) NSString *contextEventType; +@property(nonatomic, strong, nullable) NSNumber *failureCount; + +/** + * Count of entries that were processed successfully. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *successCount; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Configurations for a Search Engine. + * Response of the ImportUserEventsRequest. If the long running operation was + * successful, then this message is returned by the + * google.longrunning.Operations.response field if the operation was + * successful. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig : GTLRObject - -/** The add-on that this search engine enables. */ -@property(nonatomic, strong, nullable) NSArray *searchAddOns; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportUserEventsResponse : GTLRObject /** - * The search feature tier of this engine. Different tiers might have different - * pricing. To learn more, check the pricing documentation. Defaults to - * SearchTier.SEARCH_TIER_STANDARD if not specified. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig_SearchTier_SearchTierEnterprise - * Enterprise tier. (Value: "SEARCH_TIER_ENTERPRISE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig_SearchTier_SearchTierStandard - * Standard tier. (Value: "SEARCH_TIER_STANDARD") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig_SearchTier_SearchTierUnspecified - * Default value when the enum is unspecified. This is invalid to use. - * (Value: "SEARCH_TIER_UNSPECIFIED") + * Echoes the destination for the complete errors if this field was set in the + * request. */ -@property(nonatomic, copy, nullable) NSString *searchTier; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; -@end +/** A sample of errors encountered while processing the request. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * Count of user events imported with complete existing Documents. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *joinedEventsCount; /** - * An evaluation is a single execution (or run) of an evaluation process. It - * encapsulates the state of the evaluation and the resulting data. + * Count of user events imported, but with Document information not found in + * the existing Branch. + * + * Uses NSNumber of longLongValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *unjoinedEventsCount; -/** Output only. Timestamp the Evaluation was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@end -/** Output only. Timestamp the Evaluation was completed at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; /** - * Output only. The error that occurred during evaluation. Only populated when - * the evaluation's state is FAILED. + * A floating point interval. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaInterval : GTLRObject /** - * Output only. A sample of errors encountered while processing the request. + * Exclusive upper bound. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; - -/** Required. The specification of the evaluation. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec *evaluationSpec; +@property(nonatomic, strong, nullable) NSNumber *exclusiveMaximum; /** - * Identifier. The full resource name of the Evaluation, in the format of - * `projects/{project}/locations/{location}/evaluations/{evaluation}`. This - * field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Exclusive lower bound. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSNumber *exclusiveMinimum; /** - * Output only. The metrics produced by the evaluation, averaged across all - * SampleQuerys in the SampleQuerySet. Only populated when the evaluation's - * state is SUCCEEDED. + * Inclusive upper bound. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetrics *qualityMetrics; +@property(nonatomic, strong, nullable) NSNumber *maximum; /** - * Output only. The state of the evaluation. + * Inclusive lower bound. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Failed - * The evaluation failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Pending - * The service is preparing to run the evaluation. (Value: "PENDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Running - * The evaluation is in progress. (Value: "RUNNING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_StateUnspecified - * The evaluation is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluation_State_Succeeded - * The evaluation completed successfully. (Value: "SUCCEEDED") + * Uses NSNumber of doubleValue. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, strong, nullable) NSNumber *minimum; @end /** - * Describes the specification of the evaluation. + * Language info for DataStore. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec : GTLRObject - -/** Optional. The specification of the query set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec *querySetSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLanguageInfo : GTLRObject /** - * Required. The search request that is used to perform the evaluation. Only - * the following fields within SearchRequest are supported; if any other fields - * are provided, an UNSUPPORTED error will be returned: * - * SearchRequest.serving_config * SearchRequest.branch * - * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * - * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * - * SearchRequest.user_pseudo_id + * Output only. Language part of normalized_language_code. E.g.: `en-US` -> + * `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest *searchRequest; - -@end +@property(nonatomic, copy, nullable) NSString *language; +/** The language code for the DataStore. */ +@property(nonatomic, copy, nullable) NSString *languageCode; /** - * Describes the specification of the query set. + * Output only. This is the normalized form of language_code. E.g.: + * language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have + * normalized_language_code of `en-GB`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *normalizedLanguageCode; /** - * Optional. The full resource name of the SampleQuerySet used for the - * evaluation, in the format of - * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. + * Output only. Region part of normalized_language_code, if present. E.g.: + * `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. */ -@property(nonatomic, copy, nullable) NSString *sampleQuerySet; +@property(nonatomic, copy, nullable) NSString *region; @end /** - * Config to data store for `HEALTHCARE_FHIR` vertical. + * Information about users' licenses. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig : GTLRObject + +/** Optional. The alert policy config for this license config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaAlertPolicyResourceConfig *alertPolicyResourceConfig; /** - * Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set - * to `true`, the predefined healthcare fhir schema can be extended for more - * customized searching and filtering. + * Optional. Whether the license config should be auto renewed when it reaches + * the end date. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *enableConfigurableSchema; +@property(nonatomic, strong, nullable) NSNumber *autoRenew; + +/** Optional. The planed end date. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *endDate; /** - * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If - * set to `true`, the batch ingestion will be processed in a static indexing - * mode which is slower but more capable of handling larger volume. + * Optional. Whether the license config is for free trial. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *enableStaticIndexingForBatchIngestion; +@property(nonatomic, strong, nullable) NSNumber *freeTrial; -@end +/** + * Required. Number of licenses purchased. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *licenseCount; + +/** + * Immutable. Identifier. The fully qualified resource name of the license + * config. Format: + * `projects/{project}/locations/{location}/licenseConfigs/{license_config}` + */ +@property(nonatomic, copy, nullable) NSString *name; +/** Required. The start date. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *startDate; /** - * IdentityMappingEntry LongRunningOperation metadata for - * IdentityMappingStoreService.ImportIdentityMappings and - * IdentityMappingStoreService.PurgeIdentityMappings + * Output only. The state of the license config. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_Active + * The license config is effective and being used. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_Expired + * The license config has expired. (Value: "EXPIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_NotStarted + * The license config has not started yet, and its start date is in the + * future. (Value: "NOT_STARTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_State_StateUnspecified + * Default value. The license config does not exist. (Value: + * "STATE_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *state; /** - * The number of IdentityMappingEntries that failed to be processed. + * Required. Subscription term. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth + * 1 month. (Value: "SUBSCRIPTION_TERM_ONE_MONTH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermOneYear + * 1 year. (Value: "SUBSCRIPTION_TERM_ONE_YEAR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears + * 3 years. (Value: "SUBSCRIPTION_TERM_THREE_YEARS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified + * Default value, do not use. (Value: "SUBSCRIPTION_TERM_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *subscriptionTerm; /** - * The number of IdentityMappingEntries that were successfully processed. + * Required. Subscription tier information for the license config. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness + * Agentspace Business tier. (Value: + * "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter + * Agentspace Starter tier. (Value: + * "SUBSCRIPTION_TIER_AGENTSPACE_STARTER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEdu + * EDU tier. (Value: "SUBSCRIPTION_TIER_EDU") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging + * EDU emerging market tier. (Value: "SUBSCRIPTION_TIER_EDU_EMERGING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduPro + * EDU Pro tier. (Value: "SUBSCRIPTION_TIER_EDU_PRO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging + * EDU Pro emerging market tier. (Value: + * "SUBSCRIPTION_TIER_EDU_PRO_EMERGING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierEnterprise + * Enterprise tier. (Value: "SUBSCRIPTION_TIER_ENTERPRISE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker + * Frontline worker tier. (Value: "SUBSCRIPTION_TIER_FRONTLINE_WORKER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm + * NotebookLM tier. NotebookLM is a subscription tier can only access + * NotebookLM features. (Value: "SUBSCRIPTION_TIER_NOTEBOOK_LM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierSearch + * Search tier. Search tier can access VAIS search features and + * NotebookLM features. (Value: "SUBSCRIPTION_TIER_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant + * Search + assistant tier. Search + assistant tier can access VAIS + * search features, NotebookLM features and assistant features. (Value: + * "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLicenseConfig_SubscriptionTier_SubscriptionTierUnspecified + * Default value. (Value: "SUBSCRIPTION_TIER_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *subscriptionTier; + +@end + + +/** + * Configuration for Natural Language Query Understanding. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig : GTLRObject /** - * The total number of IdentityMappingEntries that were processed. + * Mode of Natural Language Query Understanding. If this field is unset, the + * behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_Disabled + * Natural Language Query Understanding is disabled. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_Enabled + * Natural Language Query Understanding is enabled. (Value: "ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_ModeUnspecified + * Default value. (Value: "MODE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@property(nonatomic, copy, nullable) NSString *mode; @end /** - * Identity Provider Config. + * Response message for CrawlRateManagementService.ObtainCrawlRate method. The + * response contains organcic or dedicated crawl rate time series data for + * monitoring, depending on whether dedicated crawl rate is set. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse : GTLRObject -/** External Identity provider config. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig *externalIdpConfig; +/** + * The historical dedicated crawl rate timeseries data, used for monitoring. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries *dedicatedCrawlRateTimeSeries; + +/** Errors from service when handling the request. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; + +/** The historical organic crawl rate timeseries data, used for monitoring. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries *organicCrawlRateTimeSeries; /** - * Identity provider type configured. + * Output only. The state of the response. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_Gsuite - * Google 1P provider. (Value: "GSUITE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_IdpTypeUnspecified - * Default value. ACL search not enabled. (Value: "IDP_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfig_IdpType_ThirdParty - * Third party provider. (Value: "THIRD_PARTY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse_State_Failed + * The state is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse_State_StateUnspecified + * The state is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse_State_Succeeded + * The state is successful. (Value: "SUCCEEDED") */ -@property(nonatomic, copy, nullable) NSString *idpType; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Third party IDP Config. + * The historical organic crawl rate timeseries data, used for monitoring. + * Organic crawl is auto-determined by Google to crawl the user's website when + * dedicate crawl is not set. Crawl rate is the QPS of crawl request Google + * sends to the user's website. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaIdpConfigExternalIdpConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries : GTLRObject -/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */ -@property(nonatomic, copy, nullable) NSString *workforcePoolName; +/** + * Google's organic crawl rate time series, which is the sum of all googlebots' + * crawl rate. Please refer to + * https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers + * for more details about googlebots. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *googleOrganicCrawlRate; + +/** + * Vertex AI's organic crawl rate time series, which is the crawl rate of + * Google-CloudVertexBot when dedicate crawl is not set. Please refer to + * https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot + * for more details about Google-CloudVertexBot. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *vertexAiOrganicCrawlRate; @end /** - * Metadata related to the progress of the ImportCompletionSuggestions - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Metadata and configurations for a Google Cloud project in the service. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject : GTLRObject -/** Operation create time. */ +/** Output only. The timestamp when this project is created. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. Customer provided configurations. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig *customerProvidedConfig; + /** - * Count of CompletionSuggestions that failed to be imported. - * - * Uses NSNumber of longLongValue. + * Output only. Full resource name of the project, for example + * `projects/{project}`. Note that when making requests, project number and + * project id are both acceptable, but the server will always respond in + * project number. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *name; /** - * Count of CompletionSuggestions successfully imported. - * - * Uses NSNumber of longLongValue. + * Output only. The timestamp when this project is successfully provisioned. + * Empty value means this project is still provisioning and is not ready for + * use. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, strong, nullable) GTLRDateTime *provisionCompletionTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Output only. A map of terms of services. The key is the `id` of + * ServiceTerms. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject_ServiceTermsMap *serviceTermsMap; @end /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the - * long running operation is done, this message is returned by the - * google.longrunning.Operations.response field if the operation is successful. + * Output only. A map of terms of services. The key is the `id` of + * ServiceTerms. + * + * @note This class is documented as having more properties of + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms. + * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get + * the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject_ServiceTermsMap : GTLRObject +@end -/** The desired location of errors incurred during the Import. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * Customer provided configurations. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig : GTLRObject + +/** Optional. Configuration for NotebookLM settings. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig *notebooklmConfig; @end /** - * Metadata related to the progress of the ImportDocuments operation. This is - * returned by the google.longrunning.Operation.metadata field. + * Configuration for NotebookLM. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig : GTLRObject /** - * Count of entries that encountered errors while processing. - * - * Uses NSNumber of longLongValue. + * Model Armor configuration to be used for sanitizing user prompts and LLM + * responses. */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig *modelArmorConfig; + +@end + /** - * Count of entries that were processed successfully. - * - * Uses NSNumber of longLongValue. + * Configuration for customer defined Model Armor templates to be used for + * sanitizing user prompts and LLM responses. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig : GTLRObject /** - * Total count of entries that were processed. - * - * Uses NSNumber of longLongValue. + * Optional. The resource name of the Model Armor Template for sanitizing LLM + * responses. Format: + * projects/{project}/locations/{location}/templates/{template_id} If not + * specified, no sanitization will be applied to the LLM response. */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@property(nonatomic, copy, nullable) NSString *responseTemplate; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. The resource name of the Model Armor Template for sanitizing user + * prompts. Format: + * projects/{project}/locations/{location}/templates/{template_id} If not + * specified, no sanitization will be applied to the user prompt. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *userPromptTemplate; @end /** - * Response of the ImportDocumentsRequest. If the long running operation is - * done, then this message is returned by the - * google.longrunning.Operations.response field if the operation was - * successful. + * Metadata about the terms of service. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportDocumentsResponse : GTLRObject - -/** Echoes the destination for the complete errors in the request if set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms : GTLRObject -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** The last time when the project agreed to the terms of service. */ +@property(nonatomic, strong, nullable) GTLRDateTime *acceptTime; -@end +/** + * The last time when the project declined or revoked the agreement to terms of + * service. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *declineTime; +/** + * The unique identifier of this terms of service. Available terms: * + * `GA_DATA_USE_TERMS`: [Terms for data + * use](https://cloud.google.com/retail/data-use-terms). When using this as + * `id`, the acceptable version to provide is `2022-11-23`. + * + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + */ +@property(nonatomic, copy, nullable) NSString *identifier; /** - * Configuration of destination for Import related errors. + * Whether the project has accepted/rejected the service terms or it is still + * pending. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_StateUnspecified + * The default value of the enum. This value is not actually used. + * (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_TermsAccepted + * The project has given consent to the terms of service. (Value: + * "TERMS_ACCEPTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_TermsDeclined + * The project has declined or revoked the agreement to terms of service. + * (Value: "TERMS_DECLINED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_TermsPending + * The project is pending to review and accept the terms of service. + * (Value: "TERMS_PENDING") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig : GTLRObject +@property(nonatomic, copy, nullable) NSString *state; /** - * Cloud Storage prefix for import errors. This must be an empty, existing - * Cloud Storage directory. Import errors are written to sharded files in this - * directory, one per line, as a JSON-encoded `google.rpc.Status` message. + * The version string of the terms of service. For acceptable values, see the + * comments for id above. */ -@property(nonatomic, copy, nullable) NSString *gcsPrefix; +@property(nonatomic, copy, nullable) NSString *version; @end /** - * Response message for IdentityMappingStoreService.ImportIdentityMappings + * Metadata associated with a project provision operation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse : GTLRObject - -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata : GTLRObject @end /** - * Metadata related to the progress of the ImportSampleQueries operation. This - * will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the PurgeDocuments operation. This will + * be returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata : GTLRObject -/** ImportSampleQueries operation create time. */ +/** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Count of SampleQuerys that failed to be imported. + * Count of entries that encountered errors while processing. * * Uses NSNumber of longLongValue. */ @property(nonatomic, strong, nullable) NSNumber *failureCount; /** - * Count of SampleQuerys successfully imported. + * Count of entries that were ignored as entries were not found. * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, strong, nullable) NSNumber *ignoredCount; /** - * Total count of SampleQuerys that were processed. + * Count of entries that were deleted successfully. * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *totalCount; +@property(nonatomic, strong, nullable) NSNumber *successCount; /** - * ImportSampleQueries operation last update time. If the operation is done, - * this is also the finish time. + * Operation last update time. If the operation is done, this is also the + * finish time. */ @property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @@ -19964,27 +22803,35 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response of the SampleQueryService.ImportSampleQueries method. If the long - * running operation is done, this message is returned by the - * google.longrunning.Operations.response field if the operation is successful. + * Response message for DocumentService.PurgeDocuments method. If the long + * running operation is successfully done, then this message is returned by the + * google.longrunning.Operations.response field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse : GTLRObject -/** The desired location of errors incurred during the Import. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; +/** + * The total count of documents purged as a result of the operation. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *purgeCount; -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * A sample of document names that will be deleted. Only populated if `force` + * is set to false. A max of 100 names will be returned and the names are + * chosen at random. + */ +@property(nonatomic, strong, nullable) NSArray *purgeSample; @end /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries + * Metadata related to the progress of the PurgeSuggestionDenyListEntries * operation. This is returned by the google.longrunning.Operation.metadata * field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata : GTLRObject /** Operation create time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -19999,4205 +22846,4495 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** - * Response message for CompletionService.ImportSuggestionDenyListEntries + * Response message for CompletionService.PurgeSuggestionDenyListEntries * method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse : GTLRObject /** A sample of errors encountered while processing the request. */ @property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * Count of deny list entries that failed to be imported. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *failedEntriesCount; - -/** - * Count of deny list entries successfully imported. + * Number of suggestion deny list entries purged. * * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *importedEntriesCount; +@property(nonatomic, strong, nullable) NSNumber *purgeCount; @end /** - * Metadata related to the progress of the Import operation. This is returned - * by the google.longrunning.Operation.metadata field. + * Describes the metrics produced by the evaluation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetrics : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Normalized discounted cumulative gain (NDCG) per document, at various top-k + * cutoff levels. NDCG measures the ranking quality, giving higher relevance to + * top results. Example (top-3): Suppose SampleQuery with three retrieved + * documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 + * for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 + * (1), D3 (0)] Calculate NDCG\@3 for each SampleQuery: * DCG\@3: 0/log2(1+1) + + * 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + + * 0/log2(3+1) = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *docNdcg; /** - * Count of entries that encountered errors while processing. - * - * Uses NSNumber of longLongValue. + * Precision per document, at various top-k cutoff levels. Precision is the + * fraction of retrieved documents that are relevant. Example (top-5): * For a + * single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are + * relevant, precision\@5 = 4/5 = 0.8 */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *docPrecision; /** - * Count of entries that were processed successfully. - * - * Uses NSNumber of longLongValue. + * Recall per document, at various top-k cutoff levels. Recall is the fraction + * of relevant documents retrieved out of all relevant documents. Example + * (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are + * retrieved in the top-5, recall\@5 = 3/5 = 0.6 */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *docRecall; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Normalized discounted cumulative gain (NDCG) per page, at various top-k + * cutoff levels. NDCG measures the ranking quality, giving higher relevance to + * top results. Example (top-3): Suppose SampleQuery with three retrieved pages + * (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not + * relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 + * (0)] Calculate NDCG\@3 for SampleQuery: * DCG\@3: 0/log2(1+1) + 1/log2(2+1) + * + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) + * = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *pageNdcg; + +/** + * Recall per page, at various top-k cutoff levels. Recall is the fraction of + * relevant pages retrieved out of all relevant pages. Example (top-5): * For a + * single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, + * recall\@5 = 3/5 = 0.6 + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *pageRecall; @end /** - * Response of the ImportUserEventsRequest. If the long running operation was - * successful, then this message is returned by the - * google.longrunning.Operations.response field if the operation was - * successful. + * Stores the metric values at specific top-k levels. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportUserEventsResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics : GTLRObject /** - * Echoes the destination for the complete errors if this field was set in the - * request. + * The top-1 value. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; +@property(nonatomic, strong, nullable) NSNumber *top1; -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** + * The top-10 value. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *top10; /** - * Count of user events imported with complete existing Documents. + * The top-3 value. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *joinedEventsCount; +@property(nonatomic, strong, nullable) NSNumber *top3; /** - * Count of user events imported, but with Document information not found in - * the existing Branch. + * The top-5 value. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *unjoinedEventsCount; +@property(nonatomic, strong, nullable) NSNumber *top5; @end /** - * A floating point interval. + * Metadata related to the progress of the + * CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaInterval : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata : GTLRObject -/** - * Exclusive upper bound. - * - * Uses NSNumber of doubleValue. - */ -@property(nonatomic, strong, nullable) NSNumber *exclusiveMaximum; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Exclusive lower bound. - * - * Uses NSNumber of doubleValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *exclusiveMinimum; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * Inclusive upper bound. - * - * Uses NSNumber of doubleValue. + * Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate + * method. It simply returns the state of the response, and an error message if + * the state is FAILED. */ -@property(nonatomic, strong, nullable) NSNumber *maximum; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse : GTLRObject + +/** Errors from service when handling the request. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; /** - * Inclusive lower bound. + * Output only. The state of the response. * - * Uses NSNumber of doubleValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse_State_Failed + * The state is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse_State_StateUnspecified + * The state is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse_State_Succeeded + * The state is successful. (Value: "SUCCEEDED") */ -@property(nonatomic, strong, nullable) NSNumber *minimum; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Language info for DataStore. + * Defines the structure and layout of a type of document data. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaLanguageInfo : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema : GTLRObject + +/** The JSON representation of the schema. */ +@property(nonatomic, copy, nullable) NSString *jsonSchema; /** - * Output only. Language part of normalized_language_code. E.g.: `en-US` -> - * `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + * Immutable. The full resource name of the schema, in the format of + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. + * This field must be a UTF-8 encoded string with a length limit of 1024 + * characters. */ -@property(nonatomic, copy, nullable) NSString *language; +@property(nonatomic, copy, nullable) NSString *name; -/** The language code for the DataStore. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +/** The structured representation of the schema. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema_StructSchema *structSchema; + +@end -/** - * Output only. This is the normalized form of language_code. E.g.: - * language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have - * normalized_language_code of `en-GB`. - */ -@property(nonatomic, copy, nullable) NSString *normalizedLanguageCode; /** - * Output only. Region part of normalized_language_code, if present. E.g.: - * `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + * The structured representation of the schema. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *region; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema_StructSchema : GTLRObject @end /** - * Configuration for Natural Language Query Understanding. + * Promotion proto includes uri and other helping information to display the + * promotion. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchLinkPromotion : GTLRObject /** - * Mode of Natural Language Query Understanding. If this field is unset, the - * behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + * Optional. The Promotion description. Maximum length: 200 characters. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_Disabled - * Natural Language Query Understanding is disabled. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_Enabled - * Natural Language Query Understanding is enabled. (Value: "ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig_Mode_ModeUnspecified - * Default value. (Value: "MODE_UNSPECIFIED") + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. */ -@property(nonatomic, copy, nullable) NSString *mode; - -@end - +@property(nonatomic, copy, nullable) NSString *descriptionProperty; /** - * Response message for CrawlRateManagementService.ObtainCrawlRate method. The - * response contains organcic or dedicated crawl rate time series data for - * monitoring, depending on whether dedicated crawl rate is set. + * Optional. The Document the user wants to promote. For site search, leave + * unset and only populate uri. Can be set along with uri. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse : GTLRObject +@property(nonatomic, copy, nullable) NSString *document; /** - * The historical dedicated crawl rate timeseries data, used for monitoring. + * Optional. The enabled promotion will be returned for any serving configs + * associated with the parent of the control this promotion is attached to. + * This flag is used for basic site search only. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries *dedicatedCrawlRateTimeSeries; +@property(nonatomic, strong, nullable) NSNumber *enabled; -/** Errors from service when handling the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +/** Optional. The promotion thumbnail image url. */ +@property(nonatomic, copy, nullable) NSString *imageUri; -/** The historical organic crawl rate timeseries data, used for monitoring. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries *organicCrawlRateTimeSeries; +/** Required. The title of the promotion. Maximum length: 160 characters. */ +@property(nonatomic, copy, nullable) NSString *title; /** - * Output only. The state of the response. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse_State_Failed - * The state is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse_State_StateUnspecified - * The state is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse_State_Succeeded - * The state is successful. (Value: "SUCCEEDED") + * Optional. The URL for the page the user wants to promote. Must be set for + * site search. For other verticals, this is optional. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * The historical organic crawl rate timeseries data, used for monitoring. - * Organic crawl is auto-determined by Google to crawl the user's website when - * dedicate crawl is not set. Crawl rate is the QPS of crawl request Google - * sends to the user's website. + * Request message for SearchService.Search method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest : GTLRObject /** - * Google's organic crawl rate time series, which is the sum of all googlebots' - * crawl rate. Please refer to - * https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers - * for more details about googlebots. + * Boost specification to boost certain documents. For more information on + * boosting, see + * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *googleOrganicCrawlRate; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec *boostSpec; /** - * Vertex AI's organic crawl rate time series, which is the crawl rate of - * Google-CloudVertexBot when dedicate crawl is not set. Please refer to - * https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot - * for more details about Google-CloudVertexBot. + * The branch resource name, such as `projects/ * + * /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. + * Use `default_branch` as the branch ID or leave this field empty, to search + * documents under the default branch. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries *vertexAiOrganicCrawlRate; - -@end - +@property(nonatomic, copy, nullable) NSString *branch; /** - * Metadata and configurations for a Google Cloud project in the service. + * The default filter that is applied when a user performs a search without + * checking any filters on the search page. The filter applied to every search + * request when quality improvement such as query expansion is needed. In the + * case a query does not have a sufficient amount of results this filter will + * be used to determine whether or not to enable the query expansion flow. The + * original filter will still be used for the query expanded search. This field + * is strongly recommended to achieve high search quality. For more information + * about filter syntax, see SearchRequest.filter. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject : GTLRObject +@property(nonatomic, copy, nullable) NSString *canonicalFilter; -/** Output only. The timestamp when this project is created. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** A specification for configuring the behavior of content search. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec *contentSearchSpec; /** - * Output only. Full resource name of the project, for example - * `projects/{project}`. Note that when making requests, project number and - * project id are both acceptable, but the server will always respond in - * project number. + * Specifications that define the specific DataStores to be searched, along + * with configurations for those data stores. This is only considered for + * Engines with multiple data stores. For engines with a single data store, the + * specs directly under SearchRequest should be used. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSArray *dataStoreSpecs; /** - * Output only. The timestamp when this project is successfully provisioned. - * Empty value means this project is still provisioning and is not ready for - * use. + * Optional. Config for display feature, like match highlighting on search + * results. */ -@property(nonatomic, strong, nullable) GTLRDateTime *provisionCompletionTime; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec *displaySpec; /** - * Output only. A map of terms of services. The key is the `id` of - * ServiceTerms. + * Uses the provided embedding to do additional semantic document retrieval. + * The retrieval is based on the dot product of + * SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document + * embedding that is provided in + * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If + * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it + * will use ServingConfig.EmbeddingConfig.field_path. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject_ServiceTermsMap *serviceTermsMap; - -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec *embeddingSpec; +/** + * Facet specifications for faceted search. If empty, no facets are returned. A + * maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is + * returned. + */ +@property(nonatomic, strong, nullable) NSArray *facetSpecs; /** - * Output only. A map of terms of services. The key is the `id` of - * ServiceTerms. - * - * @note This class is documented as having more properties of - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms. - * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get - * the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * The filter syntax consists of an expression language for constructing a + * predicate from one or more fields of the documents being filtered. Filter + * expression is case-sensitive. If this field is unrecognizable, an + * `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by + * mapping the LHS filter key to a key property defined in the Vertex AI Search + * backend -- this mapping is defined by the customer in their schema. For + * example a media customer might have a field 'name' in their schema. In this + * case the filter would look like this: filter --> name:'ANY("king kong")' For + * more information about filtering including syntax and filter operators, see + * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProject_ServiceTermsMap : GTLRObject -@end +@property(nonatomic, copy, nullable) NSString *filter; +/** Raw image query. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery *imageQuery; /** - * Metadata about the terms of service. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more + * information, see [Standard + * fields](https://cloud.google.com/apis/design/standard_fields). This field + * helps to better interpret the query. If a value isn't specified, the query + * language code is automatically detected, which may not be accurate. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms : GTLRObject +@property(nonatomic, copy, nullable) NSString *languageCode; -/** The last time when the project agreed to the terms of service. */ -@property(nonatomic, strong, nullable) GTLRDateTime *acceptTime; +/** + * Optional. Config for natural language query understanding capabilities, such + * as extracting structured field filters from the query. Refer to [this + * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) + * for more information. If `naturalLanguageQueryUnderstandingSpec` is not + * specified, no additional natural language query understanding will be done. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec *naturalLanguageQueryUnderstandingSpec; /** - * The last time when the project declined or revoked the agreement to terms of - * service. + * A 0-indexed integer that specifies the current offset (that is, starting + * result location, amongst the Documents deemed by the API as relevant) in + * search results. This field is only considered if page_token is unset. If + * this field is negative, an `INVALID_ARGUMENT` is returned. A large offset + * may be capped to a reasonable threshold. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *declineTime; +@property(nonatomic, strong, nullable) NSNumber *offset; /** - * The unique identifier of this terms of service. Available terms: * - * `GA_DATA_USE_TERMS`: [Terms for data - * use](https://cloud.google.com/retail/data-use-terms). When using this as - * `id`, the acceptable version to provide is `2022-11-23`. + * The maximum number of results to return for OneBox. This applies to each + * OneBox type individually. Default number is 10. * - * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *oneBoxPageSize; + +/** + * The order in which documents are returned. Documents can be ordered by a + * field in an Document object. Leave it unset if ordered by relevance. + * `order_by` expression is case-sensitive. For more information on ordering + * the website search results, see [Order web search + * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + * For more information on ordering the healthcare search results, see [Order + * healthcare search + * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ -@property(nonatomic, copy, nullable) NSString *identifier; +@property(nonatomic, copy, nullable) NSString *orderBy; /** - * Whether the project has accepted/rejected the service terms or it is still - * pending. + * Maximum number of Documents to return. The maximum allowed value depends on + * the data type. Values above the maximum value are coerced to the maximum + * value. * Websites with basic indexing: Default `10`, Maximum `25`. * + * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: + * Default `50`, Maximum `100`. If this field is negative, an + * `INVALID_ARGUMENT` is returned. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_StateUnspecified - * The default value of the enum. This value is not actually used. - * (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_TermsAccepted - * The project has given consent to the terms of service. (Value: - * "TERMS_ACCEPTED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_TermsDeclined - * The project has declined or revoked the agreement to terms of service. - * (Value: "TERMS_DECLINED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProjectServiceTerms_State_TermsPending - * The project is pending to review and accept the terms of service. - * (Value: "TERMS_PENDING") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, strong, nullable) NSNumber *pageSize; /** - * The version string of the terms of service. For acceptable values, see the - * comments for id above. + * A page token received from a previous SearchService.Search call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters + * provided to SearchService.Search must match the call that provided the page + * token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ -@property(nonatomic, copy, nullable) NSString *version; - -@end +@property(nonatomic, copy, nullable) NSString *pageToken; +/** + * Additional search parameters. For public website search only, supported + * values are: * `user_country_code`: string. Default empty. If set to + * non-empty, results are restricted or boosted based on the location provided. + * For example, `user_country_code: "au"` For available codes see [Country + * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * * `search_type`: double. Default empty. Enables non-webpage searching + * depending on the value. The only valid non-default value is 1, which enables + * image searching. For example, `search_type: 1` + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_Params *params; /** - * Metadata associated with a project provision operation. + * The specification for personalization. Notice that if both + * ServingConfig.personalization_spec and SearchRequest.personalization_spec + * are set, SearchRequest.personalization_spec overrides + * ServingConfig.personalization_spec. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata : GTLRObject -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec *personalizationSpec; +/** Raw search query. */ +@property(nonatomic, copy, nullable) NSString *query; /** - * Metadata related to the progress of the PurgeDocuments operation. This will - * be returned by the google.longrunning.Operation.metadata field. + * The query expansion specification that specifies the conditions under which + * query expansion occurs. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec *queryExpansionSpec; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * Optional. The ranking expression controls the customized ranking on + * retrieval documents. This overrides ServingConfig.ranking_expression. The + * syntax and supported features depend on the `ranking_expression_backend` + * value. If `ranking_expression_backend` is not provided, it defaults to + * `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to + * `RANK_BY_EMBEDDING`, it should be a single function or multiple functions + * that are joined by "+". * ranking_expression = function, { " + ", function + * }; Supported functions: * double * relevance_score * double * + * dotProduct(embedding_field_path) Function variables: * `relevance_score`: + * pre-defined keywords, used for measure relevance between query and document. + * * `embedding_field_path`: the document embedding field used with query + * embedding vector. * `dotProduct`: embedding function between + * `embedding_field_path` and query embedding vector. Example ranking + * expression: If document has an embedding field doc_embedding, the ranking + * expression could be `0.5 * relevance_score + 0.3 * + * dotProduct(doc_embedding)`. If ranking_expression_backend is set to + * `RANK_BY_FORMULA`, the following expression types (and combinations of those + * chained using + or * operators) are supported: * `double` * `signal` * + * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank + * transformation with second argument being a denominator constant. * + * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * + * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 + * | double, else returns signal1. Here are a few examples of ranking formulas + * that use the supported ranking expression types: - `0.2 * + * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly + * rank by the logarithm of `keyword_similarity_score` with slight + * `semantic_smilarity_score` adjustment. - `0.2 * + * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * + * is_nan(keyword_similarity_score)` -- rank by the exponent of + * `semantic_similarity_score` filling the value with 0 if it's NaN, also add + * constant 0.3 adjustment to the final score if `semantic_similarity_score` is + * NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * + * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of + * `keyword_similarity_score` with slight adjustment of reciprocal rank of + * `semantic_smilarity_score`. The following signals are supported: * + * `semantic_similarity_score`: semantic similarity adjustment that is + * calculated using the embeddings generated by a proprietary Google model. + * This score determines how semantically similar a search query is to a + * document. * `keyword_similarity_score`: keyword match adjustment uses the + * Best Match 25 (BM25) ranking function. This score is calculated using a + * probabilistic model to estimate the probability that a document is relevant + * to a given query. * `relevance_score`: semantic relevance adjustment that + * uses a proprietary Google model to determine the meaning and intent behind a + * user's query in context with the content in the documents. * `pctr_rank`: + * predicted conversion rate adjustment as a rank use predicted Click-through + * rate (pCTR) to gauge the relevance and attractiveness of a search result + * from a user's perspective. A higher pCTR suggests that the result is more + * likely to satisfy the user's query and intent, making it a valuable signal + * for ranking. * `freshness_rank`: freshness adjustment as a rank * + * `document_age`: The time in hours elapsed since the document was last + * updated, a floating-point number (e.g., 0.25 means 15 minutes). * + * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google + * model to determine the keyword-based overlap between the query and the + * document. * `base_rank`: the default rank of the result + */ +@property(nonatomic, copy, nullable) NSString *rankingExpression; /** - * Count of entries that encountered errors while processing. + * Optional. The backend to use for the ranking expression evaluation. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_Byoe + * Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom + * embedding model, the default way to evaluate the ranking expression. + * Legacy enum option, `RANK_BY_EMBEDDING` should be used instead. + * (Value: "BYOE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_Clearbox + * Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. + * Legacy enum option, `RANK_BY_FORMULA` should be used instead. (Value: + * "CLEARBOX") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_RankByEmbedding + * Ranking by custom embedding model, the default way to evaluate the + * ranking expression. (Value: "RANK_BY_EMBEDDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_RankByFormula + * Ranking by custom formula. (Value: "RANK_BY_FORMULA") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_RankingExpressionBackendUnspecified + * Default option for unspecified/unknown values. (Value: + * "RANKING_EXPRESSION_BACKEND_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *failureCount; +@property(nonatomic, copy, nullable) NSString *rankingExpressionBackend; /** - * Count of entries that were ignored as entries were not found. - * - * Uses NSNumber of longLongValue. + * The Unicode country/region code (CLDR) of a location, such as "US" and + * "419". For more information, see [Standard + * fields](https://cloud.google.com/apis/design/standard_fields). If set, then + * results will be boosted based on the region_code provided. */ -@property(nonatomic, strong, nullable) NSNumber *ignoredCount; +@property(nonatomic, copy, nullable) NSString *regionCode; + +/** Optional. The specification for returning the relevance score. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec *relevanceScoreSpec; /** - * Count of entries that were deleted successfully. + * The relevance threshold of the search results. Default to Google defined + * threshold, leveraging a balance of precision and recall to deliver both + * highly accurate results and comprehensive coverage of relevant information. + * This feature is not supported for healthcare search. * - * Uses NSNumber of longLongValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_High + * High relevance threshold. (Value: "HIGH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_Low + * Low relevance threshold. (Value: "LOW") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_Lowest + * Lowest relevance threshold. (Value: "LOWEST") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_Medium + * Medium relevance threshold. (Value: "MEDIUM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_RelevanceThresholdUnspecified + * Default value. In this case, server behavior defaults to Google + * defined threshold. (Value: "RELEVANCE_THRESHOLD_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *successCount; +@property(nonatomic, copy, nullable) NSString *relevanceThreshold; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Whether to turn on safe search. This is only supported for website search. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end +@property(nonatomic, strong, nullable) NSNumber *safeSearch; +/** + * Optional. SearchAddonSpec is used to disable add-ons for search as per new + * repricing model. This field is only supported for search requests. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec *searchAddonSpec; /** - * Response message for DocumentService.PurgeDocuments method. If the long - * running operation is successfully done, then this message is returned by the - * google.longrunning.Operations.response field. + * Search as you type configuration. Only supported for the + * IndustryVertical.MEDIA vertical. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec *searchAsYouTypeSpec; /** - * The total count of documents purged as a result of the operation. - * - * Uses NSNumber of longLongValue. + * Required. The resource name of the Search serving config, such as `projects/ + * * /locations/global/collections/default_collection/engines/ * + * /servingConfigs/default_serving_config`, or `projects/ * + * /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. + * This field is used to identify the serving configuration name, set of models + * used to make the search. */ -@property(nonatomic, strong, nullable) NSNumber *purgeCount; +@property(nonatomic, copy, nullable) NSString *servingConfig; /** - * A sample of document names that will be deleted. Only populated if `force` - * is set to false. A max of 100 names will be returned and the names are - * chosen at random. + * The session resource name. Optional. Session allows users to do multi-turn + * /search API calls or coordination between /search API calls and /answer API + * calls. Example #1 (multi-turn /search API calls): Call /search API with the + * session ID generated in the first call. Here, the previous search query gets + * considered in query standing. I.e., if the first query is "How did Alphabet + * do in 2022?" and the current query is "How about 2023?", the current query + * will be interpreted as "How did Alphabet do in 2023?". Example #2 + * (coordination between /search API calls and /answer API calls): Call /answer + * API with the session ID generated in the first call. Here, the answer + * generation happens in the context of the search results from the first + * search call. Multi-turn Search feature is currently at private GA stage. + * Please use v1alpha or v1beta version instead before we launch this feature + * to public GA. Or ask for allowlisting through Google Support team. */ -@property(nonatomic, strong, nullable) NSArray *purgeSample; +@property(nonatomic, copy, nullable) NSString *session; -@end +/** Session specification. Can be used only when `session` is set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec *sessionSpec; +/** + * The spell correction specification that specifies the mode under which spell + * correction takes effect. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec *spellCorrectionSpec; /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries - * operation. This is returned by the google.longrunning.Operation.metadata - * field. + * Information about the end user. Highly recommended for analytics and + * personalization. UserInfo.user_agent is used to deduce `device_type` for + * analytics. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserInfo *userInfo; -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_UserLabels *userLabels; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * A unique identifier for tracking visitors. For example, this could be + * implemented with an HTTP cookie, which should be able to uniquely identify a + * visitor on a single device. This unique identifier should not change if the + * visitor logs in or out of the website. This field should NOT have a fixed + * value such as `unknown_visitor`. This should be the same identifier as + * UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field + * must be a UTF-8 encoded string with a length limit of 128 characters. + * Otherwise, an `INVALID_ARGUMENT` error is returned. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *userPseudoId; @end /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries - * method. + * Additional search parameters. For public website search only, supported + * values are: * `user_country_code`: string. Default empty. If set to + * non-empty, results are restricted or boosted based on the location provided. + * For example, `user_country_code: "au"` For available codes see [Country + * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * * `search_type`: double. Default empty. Enables non-webpage searching + * depending on the value. The only valid non-default value is 1, which enables + * image searching. For example, `search_type: 1` + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_Params : GTLRObject +@end -/** A sample of errors encountered while processing the request. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; /** - * Number of suggestion deny list entries purged. + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. * - * Uses NSNumber of longLongValue. + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *purgeCount; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_UserLabels : GTLRObject @end /** - * Describes the metrics produced by the evaluation. + * Boost specification to boost certain documents. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetrics : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec : GTLRObject /** - * Normalized discounted cumulative gain (NDCG) per document, at various top-k - * cutoff levels. NDCG measures the ranking quality, giving higher relevance to - * top results. Example (top-3): Suppose SampleQuery with three retrieved - * documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 - * for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 - * (1), D3 (0)] Calculate NDCG\@3 for each SampleQuery: * DCG\@3: 0/log2(1+1) + - * 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + - * 0/log2(3+1) = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 + * Condition boost specifications. If a document matches multiple conditions in + * the specifications, boost scores from these specifications are all applied + * and combined in a non-linear way. Maximum number of specifications is 20. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *docNdcg; +@property(nonatomic, strong, nullable) NSArray *conditionBoostSpecs; + +@end + /** - * Precision per document, at various top-k cutoff levels. Precision is the - * fraction of retrieved documents that are relevant. Example (top-5): * For a - * single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are - * relevant, precision\@5 = 4/5 = 0.8 + * Boost applies to documents which match a condition. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *docPrecision; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec : GTLRObject /** - * Recall per document, at various top-k cutoff levels. Recall is the fraction - * of relevant documents retrieved out of all relevant documents. Example - * (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are - * retrieved in the top-5, recall\@5 = 3/5 = 0.6 + * Strength of the condition boost, which should be in [-1, 1]. Negative boost + * means demotion. Default is 0.0. Setting to 1.0 gives the document a big + * promotion. However, it does not necessarily mean that the boosted document + * will be the top result at all times, nor that other documents will be + * excluded. Results could still be shown even when none of them matches the + * condition. And results that are significantly more relevant to the search + * query can still trump your heavily favored but irrelevant documents. Setting + * to -1.0 gives the document a big demotion. However, results that are deeply + * relevant might still be shown. The document will have an upstream battle to + * get a fairly high ranking, but it is not blocked out completely. Setting to + * 0.0 means no boost applied. The boosting condition is ignored. Only one of + * the (condition, boost) combination or the boost_control_spec below are set. + * If both are set then the global boost is ignored and the more fine-grained + * boost_control_spec is applied. + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *docRecall; +@property(nonatomic, strong, nullable) NSNumber *boost; /** - * Normalized discounted cumulative gain (NDCG) per page, at various top-k - * cutoff levels. NDCG measures the ranking quality, giving higher relevance to - * top results. Example (top-3): Suppose SampleQuery with three retrieved pages - * (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not - * relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 - * (0)] Calculate NDCG\@3 for SampleQuery: * DCG\@3: 0/log2(1+1) + 1/log2(2+1) - * + 1/log2(3+1) = 1.13 * Ideal DCG\@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) - * = 1.63 * NDCG\@3: 1.13/1.63 = 0.693 + * Complex specification for custom ranking based on customer defined attribute + * value. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *pageNdcg; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec *boostControlSpec; /** - * Recall per page, at various top-k cutoff levels. Recall is the fraction of - * relevant pages retrieved out of all relevant pages. Example (top-5): * For a - * single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, - * recall\@5 = 3/5 = 0.6 + * An expression which specifies a boost condition. The syntax and supported + * fields are the same as a filter expression. See SearchRequest.filter for + * detail syntax and limitations. Examples: * To boost documents with document + * ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: + * ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics *pageRecall; +@property(nonatomic, copy, nullable) NSString *condition; @end /** - * Stores the metric values at specific top-k levels. + * Specification for custom ranking based on customer specified attribute + * value. It provides more controls for customized ranking than the simple + * (condition, boost) combination above. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec : GTLRObject /** - * The top-1 value. + * The attribute type to be used to determine the boost amount. The attribute + * value can be derived from the field value of the specified field_name. In + * the case of numerical it is straightforward i.e. attribute_value = + * numerical_field_value. In the case of freshness however, attribute_value = + * (time.now() - datetime_field_value). * - * Uses NSNumber of doubleValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_AttributeTypeUnspecified + * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Freshness + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field specified. + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: + * "FRESHNESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Numerical + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) of + * the control point will be the actual value of the numerical field for + * which the boost_amount is specified. (Value: "NUMERICAL") */ -@property(nonatomic, strong, nullable) NSNumber *top1; +@property(nonatomic, copy, nullable) NSString *attributeType; /** - * The top-10 value. - * - * Uses NSNumber of doubleValue. + * The control points used to define the curve. The monotonic function (defined + * through the interpolation_type above) passes through the control points + * listed here. */ -@property(nonatomic, strong, nullable) NSNumber *top10; +@property(nonatomic, strong, nullable) NSArray *controlPoints; /** - * The top-3 value. - * - * Uses NSNumber of doubleValue. + * The name of the field whose value will be used to determine the boost + * amount. */ -@property(nonatomic, strong, nullable) NSNumber *top3; +@property(nonatomic, copy, nullable) NSString *fieldName; /** - * The top-5 value. + * The interpolation type to be applied to connect the control points listed + * below. * - * Uses NSNumber of doubleValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_InterpolationTypeUnspecified + * Interpolation type is unspecified. In this case, it defaults to + * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_Linear + * Piecewise linear interpolation will be applied. (Value: "LINEAR") */ -@property(nonatomic, strong, nullable) NSNumber *top5; +@property(nonatomic, copy, nullable) NSString *interpolationType; @end /** - * Metadata related to the progress of the - * CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be - * returned by the google.longrunning.Operation.metadata field. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The control points used to define the curve. The curve defined through these + * control points can only be monotonically increasing or decreasing(constant + * values are acceptable). */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint : GTLRObject /** - * Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate - * method. It simply returns the state of the response, and an error message if - * the state is FAILED. + * Can be one of: 1. The numerical field value. 2. The duration spec for + * freshness: The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this is: + * `nDnM]`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse : GTLRObject - -/** Errors from service when handling the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +@property(nonatomic, copy, nullable) NSString *attributeValue; /** - * Output only. The state of the response. + * The value between -1 to 1 by which to boost the score if the attribute_value + * evaluates to the value specified above. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse_State_Failed - * The state is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse_State_StateUnspecified - * The state is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse_State_Succeeded - * The state is successful. (Value: "SUCCEEDED") + * Uses NSNumber of floatValue. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, strong, nullable) NSNumber *boostAmount; @end /** - * Defines the structure and layout of a type of document data. + * A specification for configuring the behavior of content search. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema : GTLRObject - -/** The JSON representation of the schema. */ -@property(nonatomic, copy, nullable) NSString *jsonSchema; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec : GTLRObject /** - * Immutable. The full resource name of the schema, in the format of - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. - * This field must be a UTF-8 encoded string with a length limit of 1024 - * characters. + * Specifies the chunk spec to be returned from the search response. Only + * available if the SearchRequest.ContentSearchSpec.search_result_mode is set + * to CHUNKS */ -@property(nonatomic, copy, nullable) NSString *name; - -/** The structured representation of the schema. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema_StructSchema *structSchema; - -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec *chunkSpec; +/** + * If there is no extractive_content_spec provided, there will be no extractive + * answer in the search response. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec *extractiveContentSpec; /** - * The structured representation of the schema. + * Specifies the search result mode. If unspecified, the search result mode + * defaults to `DOCUMENTS`. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec_SearchResultMode_Chunks + * Returns chunks in the search result. Only available if the + * DocumentProcessingConfig.chunking_config is specified. (Value: + * "CHUNKS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec_SearchResultMode_Documents + * Returns documents in the search result. (Value: "DOCUMENTS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec_SearchResultMode_SearchResultModeUnspecified + * Default value. (Value: "SEARCH_RESULT_MODE_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSchema_StructSchema : GTLRObject -@end - +@property(nonatomic, copy, nullable) NSString *searchResultMode; /** - * Promotion proto includes uri and other helping information to display the - * promotion. + * If `snippetSpec` is not specified, snippets are not included in the search + * response. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchLinkPromotion : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec *snippetSpec; /** - * Optional. The Promotion description. Maximum length: 200 characters. - * - * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + * If `summarySpec` is not specified, summaries are not included in the search + * response. */ -@property(nonatomic, copy, nullable) NSString *descriptionProperty; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec *summarySpec; + +@end + /** - * Optional. The Document the user wants to promote. For site search, leave - * unset and only populate uri. Can be set along with uri. + * Specifies the chunk spec to be returned from the search response. Only + * available if the SearchRequest.ContentSearchSpec.search_result_mode is set + * to CHUNKS */ -@property(nonatomic, copy, nullable) NSString *document; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec : GTLRObject /** - * Optional. The enabled promotion will be returned for any serving configs - * associated with the parent of the control this promotion is attached to. - * This flag is used for basic site search only. + * The number of next chunks to be returned of the current chunk. The maximum + * allowed value is 3. If not specified, no next chunks will be returned. * - * Uses NSNumber of boolValue. + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *enabled; - -/** Optional. The promotion thumbnail image url. */ -@property(nonatomic, copy, nullable) NSString *imageUri; - -/** Required. The title of the promotion. Maximum length: 160 characters. */ -@property(nonatomic, copy, nullable) NSString *title; +@property(nonatomic, strong, nullable) NSNumber *numNextChunks; /** - * Optional. The URL for the page the user wants to promote. Must be set for - * site search. For other verticals, this is optional. + * The number of previous chunks to be returned of the current chunk. The + * maximum allowed value is 3. If not specified, no previous chunks will be + * returned. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, strong, nullable) NSNumber *numPreviousChunks; @end /** - * Request message for SearchService.Search method. + * A specification for configuring the extractive content in a search response. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec : GTLRObject /** - * Boost specification to boost certain documents. For more information on - * boosting, see - * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + * The maximum number of extractive answers returned in each search result. An + * extractive answer is a verbatim answer extracted from the original document, + * which provides a precise and contextually relevant answer to the search + * query. If the number of matching answers is less than the + * `max_extractive_answer_count`, return all of the answers. Otherwise, return + * the `max_extractive_answer_count`. At most five answers are returned for + * each SearchResult. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec *boostSpec; +@property(nonatomic, strong, nullable) NSNumber *maxExtractiveAnswerCount; /** - * The branch resource name, such as `projects/ * - * /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. - * Use `default_branch` as the branch ID or leave this field empty, to search - * documents under the default branch. + * The max number of extractive segments returned in each search result. Only + * applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED + * or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is + * a text segment extracted from the original document that is relevant to the + * search query, and, in general, more verbose than an extractive answer. The + * segment could then be used as input for LLMs to generate summaries and + * answers. If the number of matching segments is less than + * `max_extractive_segment_count`, return all of the segments. Otherwise, + * return the `max_extractive_segment_count`. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *branch; +@property(nonatomic, strong, nullable) NSNumber *maxExtractiveSegmentCount; /** - * The default filter that is applied when a user performs a search without - * checking any filters on the search page. The filter applied to every search - * request when quality improvement such as query expansion is needed. In the - * case a query does not have a sufficient amount of results this filter will - * be used to determine whether or not to enable the query expansion flow. The - * original filter will still be used for the query expanded search. This field - * is strongly recommended to achieve high search quality. For more information - * about filter syntax, see SearchRequest.filter. + * Return at most `num_next_segments` segments after each selected segments. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *canonicalFilter; +@property(nonatomic, strong, nullable) NSNumber *numNextSegments; -/** A specification for configuring the behavior of content search. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec *contentSearchSpec; +/** + * Specifies whether to also include the adjacent from each selected segments. + * Return at most `num_previous_segments` segments before each selected + * segments. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *numPreviousSegments; /** - * Specifications that define the specific DataStores to be searched, along - * with configurations for those data stores. This is only considered for - * Engines with multiple data stores. For engines with a single data store, the - * specs directly under SearchRequest should be used. + * Specifies whether to return the confidence score from the extractive + * segments in each search result. This feature is available only for new or + * allowlisted data stores. To allowlist your data store, contact your Customer + * Engineer. The default value is `false`. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *dataStoreSpecs; +@property(nonatomic, strong, nullable) NSNumber *returnExtractiveSegmentScore; + +@end + /** - * Optional. Config for display feature, like match highlighting on search - * results. + * A specification for configuring snippets in a search response. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec *displaySpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec : GTLRObject /** - * Uses the provided embedding to do additional semantic document retrieval. - * The retrieval is based on the dot product of - * SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document - * embedding that is provided in - * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If - * SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it - * will use ServingConfig.EmbeddingConfig.field_path. + * [DEPRECATED] This field is deprecated. To control snippet return, use + * `return_snippet` field. For backwards compatibility, we will return snippet + * if max_snippet_count > 0. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec *embeddingSpec; +@property(nonatomic, strong, nullable) NSNumber *maxSnippetCount GTLR_DEPRECATED; /** - * Facet specifications for faceted search. If empty, no facets are returned. A - * maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is - * returned. + * [DEPRECATED] This field is deprecated and will have no affect on the + * snippet. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *facetSpecs; +@property(nonatomic, strong, nullable) NSNumber *referenceOnly GTLR_DEPRECATED; /** - * The filter syntax consists of an expression language for constructing a - * predicate from one or more fields of the documents being filtered. Filter - * expression is case-sensitive. If this field is unrecognizable, an - * `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by - * mapping the LHS filter key to a key property defined in the Vertex AI Search - * backend -- this mapping is defined by the customer in their schema. For - * example a media customer might have a field 'name' in their schema. In this - * case the filter would look like this: filter --> name:'ANY("king kong")' For - * more information about filtering including syntax and filter operators, see - * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * If `true`, then return snippet. If no snippet can be generated, we return + * "No snippet is available for this page." A `snippet_status` with `SUCCESS` + * or `NO_SNIPPET_AVAILABLE` will also be returned. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *filter; +@property(nonatomic, strong, nullable) NSNumber *returnSnippet; + +@end -/** Raw image query. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery *imageQuery; /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more - * information, see [Standard - * fields](https://cloud.google.com/apis/design/standard_fields). This field - * helps to better interpret the query. If a value isn't specified, the query - * language code is automatically detected, which may not be accurate. + * A specification for configuring a summary returned in a search response. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec : GTLRObject /** - * Config for natural language query understanding capabilities, such as - * extracting structured field filters from the query. Refer to [this - * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) - * for more information. If `naturalLanguageQueryUnderstandingSpec` is not - * specified, no additional natural language query understanding will be done. + * Specifies whether to filter out adversarial queries. The default value is + * `false`. Google employs search-query classification to detect adversarial + * queries. No summary is returned if the search query is classified as an + * adversarial query. For example, a user might ask a question regarding + * negative comments about the company or submit a query designed to generate + * unsafe, policy-violating output. If this field is set to `true`, we skip + * generating summaries for adversarial queries and return fallback messages + * instead. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec *naturalLanguageQueryUnderstandingSpec; +@property(nonatomic, strong, nullable) NSNumber *ignoreAdversarialQuery; /** - * A 0-indexed integer that specifies the current offset (that is, starting - * result location, amongst the Documents deemed by the API as relevant) in - * search results. This field is only considered if page_token is unset. If - * this field is negative, an `INVALID_ARGUMENT` is returned. + * Optional. Specifies whether to filter out jail-breaking queries. The default + * value is `false`. Google employs search-query classification to detect + * jail-breaking queries. No summary is returned if the search query is + * classified as a jail-breaking query. A user might add instructions to the + * query to change the tone, style, language, content of the answer, or ask the + * model to act as a different entity, e.g. "Reply in the tone of a competing + * company's CEO". If this field is set to `true`, we skip generating summaries + * for jail-breaking queries and return fallback messages instead. * - * Uses NSNumber of intValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *offset; +@property(nonatomic, strong, nullable) NSNumber *ignoreJailBreakingQuery; /** - * The maximum number of results to return for OneBox. This applies to each - * OneBox type individually. Default number is 10. + * Specifies whether to filter out queries that have low relevance. The default + * value is `false`. If this field is set to `false`, all search results are + * used regardless of relevance to generate answers. If set to `true`, only + * queries with high relevance search results will generate answers. * - * Uses NSNumber of intValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *oneBoxPageSize; +@property(nonatomic, strong, nullable) NSNumber *ignoreLowRelevantContent; /** - * The order in which documents are returned. Documents can be ordered by a - * field in an Document object. Leave it unset if ordered by relevance. - * `order_by` expression is case-sensitive. For more information on ordering - * the website search results, see [Order web search - * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). - * For more information on ordering the healthcare search results, see [Order - * healthcare search - * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). - * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * Specifies whether to filter out queries that are not summary-seeking. The + * default value is `false`. Google employs search-query classification to + * detect summary-seeking queries. No summary is returned if the search query + * is classified as a non-summary seeking query. For example, `why is the sky + * blue` and `Who is the best soccer player in the world?` are summary-seeking + * queries, but `SFO airport` and `world cup 2026` are not. They are most + * likely navigational queries. If this field is set to `true`, we skip + * generating summaries for non-summary seeking queries and return fallback + * messages instead. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *orderBy; +@property(nonatomic, strong, nullable) NSNumber *ignoreNonSummarySeekingQuery; /** - * Maximum number of Documents to return. The maximum allowed value depends on - * the data type. Values above the maximum value are coerced to the maximum - * value. * Websites with basic indexing: Default `10`, Maximum `25`. * - * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: - * Default `50`, Maximum `100`. If this field is negative, an - * `INVALID_ARGUMENT` is returned. + * Specifies whether to include citations in the summary. The default value is + * `false`. When this field is set to `true`, summaries include in-line + * citation numbers. Example summary including citations: BigQuery is Google + * Cloud's fully managed and completely serverless enterprise data warehouse + * [1]. BigQuery supports all data types, works across clouds, and has built-in + * machine learning and business intelligence, all within a unified platform + * [2, 3]. The citation numbers refer to the returned search results and are + * 1-indexed. For example, [1] means that the sentence is attributed to the + * first search result. [2, 3] means that the sentence is attributed to both + * the second and third search results. * - * Uses NSNumber of intValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *pageSize; +@property(nonatomic, strong, nullable) NSNumber *includeCitations; /** - * A page token received from a previous SearchService.Search call. Provide - * this to retrieve the subsequent page. When paginating, all other parameters - * provided to SearchService.Search must match the call that provided the page - * token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Language code for Summary. Use language tags defined by + * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an + * experimental feature. */ -@property(nonatomic, copy, nullable) NSString *pageToken; +@property(nonatomic, copy, nullable) NSString *languageCode; /** - * Additional search parameters. For public website search only, supported - * values are: * `user_country_code`: string. Default empty. If set to - * non-empty, results are restricted or boosted based on the location provided. - * For example, `user_country_code: "au"` For available codes see [Country - * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - * * `search_type`: double. Default empty. Enables non-webpage searching - * depending on the value. The only valid non-default value is 1, which enables - * image searching. For example, `search_type: 1` + * If specified, the spec will be used to modify the prompt provided to the + * LLM. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_Params *params; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec *modelPromptSpec; /** - * The specification for personalization. Notice that if both - * ServingConfig.personalization_spec and SearchRequest.personalization_spec - * are set, SearchRequest.personalization_spec overrides - * ServingConfig.personalization_spec. + * If specified, the spec will be used to modify the model specification + * provided to the LLM. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec *personalizationSpec; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec *modelSpec; -/** Raw search query. */ -@property(nonatomic, copy, nullable) NSString *query; +/** Optional. Multimodal specification. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec *multimodalSpec; /** - * The query expansion specification that specifies the conditions under which - * query expansion occurs. + * The number of top results to generate the summary from. If the number of + * results returned is less than `summaryResultCount`, the summary is generated + * from all of the results. At most 10 results for documents mode, or 50 for + * chunks mode, can be used to generate a summary. The chunks mode is used when + * SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec *queryExpansionSpec; +@property(nonatomic, strong, nullable) NSNumber *summaryResultCount; /** - * Optional. The ranking expression controls the customized ranking on - * retrieval documents. This overrides ServingConfig.ranking_expression. The - * syntax and supported features depend on the `ranking_expression_backend` - * value. If `ranking_expression_backend` is not provided, it defaults to - * `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to - * `RANK_BY_EMBEDDING`, it should be a single function or multiple functions - * that are joined by "+". * ranking_expression = function, { " + ", function - * }; Supported functions: * double * relevance_score * double * - * dotProduct(embedding_field_path) Function variables: * `relevance_score`: - * pre-defined keywords, used for measure relevance between query and document. - * * `embedding_field_path`: the document embedding field used with query - * embedding vector. * `dotProduct`: embedding function between - * `embedding_field_path` and query embedding vector. Example ranking - * expression: If document has an embedding field doc_embedding, the ranking - * expression could be `0.5 * relevance_score + 0.3 * - * dotProduct(doc_embedding)`. If ranking_expression_backend is set to - * `RANK_BY_FORMULA`, the following expression types (and combinations of those - * chained using + or * operators) are supported: * `double` * `signal` * - * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank - * transformation with second argument being a denominator constant. * - * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * - * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 - * | double, else returns signal1. Here are a few examples of ranking formulas - * that use the supported ranking expression types: - `0.2 * - * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly - * rank by the logarithm of `keyword_similarity_score` with slight - * `semantic_smilarity_score` adjustment. - `0.2 * - * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * - * is_nan(keyword_similarity_score)` -- rank by the exponent of - * `semantic_similarity_score` filling the value with 0 if it's NaN, also add - * constant 0.3 adjustment to the final score if `semantic_similarity_score` is - * NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * - * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of - * `keyword_similarity_score` with slight adjustment of reciprocal rank of - * `semantic_smilarity_score`. The following signals are supported: * - * `semantic_similarity_score`: semantic similarity adjustment that is - * calculated using the embeddings generated by a proprietary Google model. - * This score determines how semantically similar a search query is to a - * document. * `keyword_similarity_score`: keyword match adjustment uses the - * Best Match 25 (BM25) ranking function. This score is calculated using a - * probabilistic model to estimate the probability that a document is relevant - * to a given query. * `relevance_score`: semantic relevance adjustment that - * uses a proprietary Google model to determine the meaning and intent behind a - * user's query in context with the content in the documents. * `pctr_rank`: - * predicted conversion rate adjustment as a rank use predicted Click-through - * rate (pCTR) to gauge the relevance and attractiveness of a search result - * from a user's perspective. A higher pCTR suggests that the result is more - * likely to satisfy the user's query and intent, making it a valuable signal - * for ranking. * `freshness_rank`: freshness adjustment as a rank * - * `document_age`: The time in hours elapsed since the document was last - * updated, a floating-point number (e.g., 0.25 means 15 minutes). * - * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google - * model to determine the keyword-based overlap between the query and the - * document. * `base_rank`: the default rank of the result + * If true, answer will be generated from most relevant chunks from top search + * results. This feature will improve summary quality. Note that with this + * feature enabled, not all top search results will be referenced and included + * in the reference list, so the citation source index only points to the + * search results listed in the reference list. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *rankingExpression; +@property(nonatomic, strong, nullable) NSNumber *useSemanticChunks; + +@end + /** - * Optional. The backend to use for the ranking expression evaluation. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_Byoe - * Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom - * embedding model, the default way to evaluate the ranking expression. - * Legacy enum option, `RANK_BY_EMBEDDING` should be used instead. - * (Value: "BYOE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_Clearbox - * Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. - * Legacy enum option, `RANK_BY_FORMULA` should be used instead. (Value: - * "CLEARBOX") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_RankByEmbedding - * Ranking by custom embedding model, the default way to evaluate the - * ranking expression. (Value: "RANK_BY_EMBEDDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_RankByFormula - * Ranking by custom formula. (Value: "RANK_BY_FORMULA") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RankingExpressionBackend_RankingExpressionBackendUnspecified - * Default option for unspecified/unknown values. (Value: - * "RANKING_EXPRESSION_BACKEND_UNSPECIFIED") + * Specification of the prompt to use with the model. */ -@property(nonatomic, copy, nullable) NSString *rankingExpressionBackend; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec : GTLRObject /** - * The Unicode country/region code (CLDR) of a location, such as "US" and - * "419". For more information, see [Standard - * fields](https://cloud.google.com/apis/design/standard_fields). If set, then - * results will be boosted based on the region_code provided. + * Text at the beginning of the prompt that instructs the assistant. Examples + * are available in the user guide. */ -@property(nonatomic, copy, nullable) NSString *regionCode; +@property(nonatomic, copy, nullable) NSString *preamble; + +@end -/** Optional. The specification for returning the relevance score. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec *relevanceScoreSpec; /** - * The relevance threshold of the search results. Default to Google defined - * threshold, leveraging a balance of precision and recall to deliver both - * highly accurate results and comprehensive coverage of relevant information. - * This feature is not supported for healthcare search. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_High - * High relevance threshold. (Value: "HIGH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_Low - * Low relevance threshold. (Value: "LOW") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_Lowest - * Lowest relevance threshold. (Value: "LOWEST") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_Medium - * Medium relevance threshold. (Value: "MEDIUM") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_RelevanceThreshold_RelevanceThresholdUnspecified - * Default value. In this case, server behavior defaults to Google - * defined threshold. (Value: "RELEVANCE_THRESHOLD_UNSPECIFIED") + * Specification of the model. */ -@property(nonatomic, copy, nullable) NSString *relevanceThreshold; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec : GTLRObject /** - * Whether to turn on safe search. This is only supported for website search. - * - * Uses NSNumber of boolValue. + * The model version used to generate the summary. Supported values are: * + * `stable`: string. Default value when no value is specified. Uses a generally + * available, fine-tuned model. For more information, see [Answer generation + * model versions and + * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * * `preview`: string. (Public preview) Uses a preview model. For more + * information, see [Answer generation model versions and + * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ -@property(nonatomic, strong, nullable) NSNumber *safeSearch; +@property(nonatomic, copy, nullable) NSString *version; + +@end + /** - * Search as you type configuration. Only supported for the - * IndustryVertical.MEDIA vertical. + * Multimodal specification: Will return an image from specified source. If + * multiple sources are specified, the pick is a quality based decision. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec *searchAsYouTypeSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec : GTLRObject /** - * Required. The resource name of the Search serving config, such as `projects/ - * * /locations/global/collections/default_collection/engines/ * - * /servingConfigs/default_serving_config`, or `projects/ * - * /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. - * This field is used to identify the serving configuration name, set of models - * used to make the search. + * Optional. Source of image returned in the answer. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_AllAvailableSources + * Behavior when service determines the pick from all available sources. + * (Value: "ALL_AVAILABLE_SOURCES") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_CorpusImageOnly + * Includes image from corpus in the answer. (Value: "CORPUS_IMAGE_ONLY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_FigureGenerationOnly + * Triggers figure generation in the answer. (Value: + * "FIGURE_GENERATION_ONLY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_ImageSourceUnspecified + * Unspecified image source (multimodal feature is disabled by default). + * (Value: "IMAGE_SOURCE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *servingConfig; +@property(nonatomic, copy, nullable) NSString *imageSource; + +@end + /** - * The session resource name. Optional. Session allows users to do multi-turn - * /search API calls or coordination between /search API calls and /answer API - * calls. Example #1 (multi-turn /search API calls): Call /search API with the - * session ID generated in the first call. Here, the previous search query gets - * considered in query standing. I.e., if the first query is "How did Alphabet - * do in 2022?" and the current query is "How about 2023?", the current query - * will be interpreted as "How did Alphabet do in 2023?". Example #2 - * (coordination between /search API calls and /answer API calls): Call /answer - * API with the session ID generated in the first call. Here, the answer - * generation happens in the context of the search results from the first - * search call. Multi-turn Search feature is currently at private GA stage. - * Please use v1alpha or v1beta version instead before we launch this feature - * to public GA. Or ask for allowlisting through Google Support team. + * A struct to define data stores to filter on in a search call and + * configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error + * is returned. */ -@property(nonatomic, copy, nullable) NSString *session; - -/** Session specification. Can be used only when `session` is set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec *sessionSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec : GTLRObject /** - * The spell correction specification that specifies the mode under which spell - * correction takes effect. + * Optional. Boost specification to boost certain documents. For more + * information on boosting, see + * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec *spellCorrectionSpec; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec *boostSpec; /** - * Information about the end user. Highly recommended for analytics and - * personalization. UserInfo.user_agent is used to deduce `device_type` for - * analytics. + * Optional. Custom search operators which if specified will be used to filter + * results from workspace data stores. For more information on custom search + * operators, see + * [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserInfo *userInfo; +@property(nonatomic, copy, nullable) NSString *customSearchOperators; /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * Required. Full resource name of DataStore, such as + * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + * The path must include the project number, project id is not supported for + * this field. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_UserLabels *userLabels; +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * A unique identifier for tracking visitors. For example, this could be - * implemented with an HTTP cookie, which should be able to uniquely identify a - * visitor on a single device. This unique identifier should not change if the - * visitor logs in or out of the website. This field should NOT have a fixed - * value such as `unknown_visitor`. This should be the same identifier as - * UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field - * must be a UTF-8 encoded string with a length limit of 128 characters. - * Otherwise, an `INVALID_ARGUMENT` error is returned. + * Optional. Filter specification to filter documents in the data store + * specified by data_store field. For more information on filtering, see + * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ -@property(nonatomic, copy, nullable) NSString *userPseudoId; +@property(nonatomic, copy, nullable) NSString *filter; @end /** - * Additional search parameters. For public website search only, supported - * values are: * `user_country_code`: string. Default empty. If set to - * non-empty, results are restricted or boosted based on the location provided. - * For example, `user_country_code: "au"` For available codes see [Country - * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) - * * `search_type`: double. Default empty. Enables non-webpage searching - * depending on the value. The only valid non-default value is 1, which enables - * image searching. For example, `search_type: 1` - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Specifies features for display, like match highlighting. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_Params : GTLRObject -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec : GTLRObject /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * The condition under which match highlighting should occur. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingConditionUnspecified + * Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. (Value: + * "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled + * Disables match highlighting on all documents. (Value: + * "MATCH_HIGHLIGHTING_DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled + * Enables match highlighting on all documents. (Value: + * "MATCH_HIGHLIGHTING_ENABLED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequest_UserLabels : GTLRObject +@property(nonatomic, copy, nullable) NSString *matchHighlightingCondition; + @end /** - * Boost specification to boost certain documents. + * The specification that uses customized query embedding vector to do semantic + * document retrieval. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec : GTLRObject -/** - * Condition boost specifications. If a document matches multiple conditions in - * the specifications, boost scores from these specifications are all applied - * and combined in a non-linear way. Maximum number of specifications is 20. - */ -@property(nonatomic, strong, nullable) NSArray *conditionBoostSpecs; +/** The embedding vector used for retrieval. Limit to 1. */ +@property(nonatomic, strong, nullable) NSArray *embeddingVectors; @end /** - * Boost applies to documents which match a condition. + * Embedding vector. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector : GTLRObject + +/** Embedding field path in schema. */ +@property(nonatomic, copy, nullable) NSString *fieldPath; /** - * Strength of the condition boost, which should be in [-1, 1]. Negative boost - * means demotion. Default is 0.0. Setting to 1.0 gives the document a big - * promotion. However, it does not necessarily mean that the boosted document - * will be the top result at all times, nor that other documents will be - * excluded. Results could still be shown even when none of them matches the - * condition. And results that are significantly more relevant to the search - * query can still trump your heavily favored but irrelevant documents. Setting - * to -1.0 gives the document a big demotion. However, results that are deeply - * relevant might still be shown. The document will have an upstream battle to - * get a fairly high ranking, but it is not blocked out completely. Setting to - * 0.0 means no boost applied. The boosting condition is ignored. Only one of - * the (condition, boost) combination or the boost_control_spec below are set. - * If both are set then the global boost is ignored and the more fine-grained - * boost_control_spec is applied. + * Query embedding vector. * * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSNumber *boost; - -/** - * Complex specification for custom ranking based on customer defined attribute - * value. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec *boostControlSpec; - -/** - * An expression which specifies a boost condition. The syntax and supported - * fields are the same as a filter expression. See SearchRequest.filter for - * detail syntax and limitations. Examples: * To boost documents with document - * ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: - * ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` - */ -@property(nonatomic, copy, nullable) NSString *condition; +@property(nonatomic, strong, nullable) NSArray *vector; @end /** - * Specification for custom ranking based on customer specified attribute - * value. It provides more controls for customized ranking than the simple - * (condition, boost) combination above. + * A facet specification to perform faceted search. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec : GTLRObject /** - * The attribute type to be used to determine the boost amount. The attribute - * value can be derived from the field value of the specified field_name. In - * the case of numerical it is straightforward i.e. attribute_value = - * numerical_field_value. In the case of freshness however, attribute_value = - * (time.now() - datetime_field_value). + * Enables dynamic position for this facet. If set to true, the position of + * this facet among all facets in the response is determined automatically. If + * dynamic facets are enabled, it is ordered together. If set to false, the + * position of this facet in the response is the same as in the request, and it + * is ranked before the facets with dynamic position enable and all dynamic + * facets. For example, you may always want to have rating facet returned in + * the response, but it's not necessarily to always display the rating facet at + * the top. In that case, you can set enable_dynamic_position to true so that + * the position of rating facet in response is determined automatically. + * Another example, assuming you have the following facets in the request: * + * "rating", enable_dynamic_position = true * "price", enable_dynamic_position + * = false * "brands", enable_dynamic_position = false And also you have a + * dynamic facets enabled, which generates a facet `gender`. Then the final + * order of the facets in the response can be ("price", "brands", "rating", + * "gender") or ("price", "brands", "gender", "rating") depends on how API + * orders "gender" and "rating" facets. However, notice that "price" and + * "brands" are always ranked at first and second position because their + * enable_dynamic_position is false. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_AttributeTypeUnspecified - * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Freshness - * For the freshness use case the attribute value will be the duration - * between the current time and the date in the datetime field specified. - * The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: - * "FRESHNESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_AttributeType_Numerical - * The value of the numerical field will be used to dynamically update - * the boost amount. In this case, the attribute_value (the x value) of - * the control point will be the actual value of the numerical field for - * which the boost_amount is specified. (Value: "NUMERICAL") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *attributeType; +@property(nonatomic, strong, nullable) NSNumber *enableDynamicPosition; /** - * The control points used to define the curve. The monotonic function (defined - * through the interpolation_type above) passes through the control points - * listed here. + * List of keys to exclude when faceting. By default, FacetKey.key is not + * excluded from the filter unless it is listed in this field. Listing a facet + * key in this field allows its values to appear as facet results, even when + * they are filtered out of search results. Using this field does not affect + * what search results are returned. For example, suppose there are 100 + * documents with the color facet "Red" and 200 documents with the color facet + * "Blue". A query containing the filter "color:ANY("Red")" and having "color" + * as FacetKey.key would by default return only "Red" documents in the search + * results, and also return "Red" with count 100 as the only color facet. + * Although there are also blue documents available, "Blue" would not be shown + * as an available facet value. If "color" is listed in "excludedFilterKeys", + * then the query returns the facet values "Red" with count 100 and "Blue" with + * count 200, because the "color" key is now excluded from the filter. Because + * this field doesn't affect search results, the search results are still + * correctly filtered to return only "Red" documents. A maximum of 100 values + * are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ -@property(nonatomic, strong, nullable) NSArray *controlPoints; +@property(nonatomic, strong, nullable) NSArray *excludedFilterKeys; -/** - * The name of the field whose value will be used to determine the boost - * amount. - */ -@property(nonatomic, copy, nullable) NSString *fieldName; +/** Required. The facet key specification. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey *facetKey; /** - * The interpolation type to be applied to connect the control points listed - * below. + * Maximum facet values that are returned for this facet. If unspecified, + * defaults to 20. The maximum allowed value is 300. Values above 300 are + * coerced to 300. For aggregation in healthcare search, when the + * [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden + * to 10,000 internally, regardless of the value set here. If this field is + * negative, an `INVALID_ARGUMENT` is returned. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_InterpolationTypeUnspecified - * Interpolation type is unspecified. In this case, it defaults to - * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec_InterpolationType_Linear - * Piecewise linear interpolation will be applied. (Value: "LINEAR") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *interpolationType; +@property(nonatomic, strong, nullable) NSNumber *limit; @end /** - * The control points used to define the curve. The curve defined through these - * control points can only be monotonically increasing or decreasing(constant - * values are acceptable). - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint : GTLRObject - -/** - * Can be one of: 1. The numerical field value. 2. The duration spec for - * freshness: The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this is: - * `nDnM]`. + * Specifies how a facet is computed. */ -@property(nonatomic, copy, nullable) NSString *attributeValue; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey : GTLRObject /** - * The value between -1 to 1 by which to boost the score if the attribute_value - * evaluates to the value specified above. + * True to make facet keys case insensitive when getting faceting values with + * prefixes or contains; false otherwise. * - * Uses NSNumber of floatValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *boostAmount; - -@end - +@property(nonatomic, strong, nullable) NSNumber *caseInsensitive; /** - * A specification for configuring the behavior of content search. + * Only get facet values that contain the given strings. For example, suppose + * "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > + * 2022". If set "contains" to "2022", the "category" facet only contains + * "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. + * Maximum is 10. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec : GTLRObject +@property(nonatomic, strong, nullable) NSArray *contains; /** - * Specifies the chunk spec to be returned from the search response. Only - * available if the SearchRequest.ContentSearchSpec.search_result_mode is set - * to CHUNKS + * Set only if values should be bucketed into intervals. Must be set for facets + * with numerical values. Must not be set for facet with text values. Maximum + * number of intervals is 30. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec *chunkSpec; +@property(nonatomic, strong, nullable) NSArray *intervals; /** - * If there is no extractive_content_spec provided, there will be no extractive - * answer in the search response. + * Required. Supported textual and numerical facet keys in Document object, + * over which the facet values are computed. Facet key is case-sensitive. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec *extractiveContentSpec; +@property(nonatomic, copy, nullable) NSString *key; /** - * Specifies the search result mode. If unspecified, the search result mode - * defaults to `DOCUMENTS`. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec_SearchResultMode_Chunks - * Returns chunks in the search result. Only available if the - * DocumentProcessingConfig.chunking_config is specified. (Value: - * "CHUNKS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec_SearchResultMode_Documents - * Returns documents in the search result. (Value: "DOCUMENTS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec_SearchResultMode_SearchResultModeUnspecified - * Default value. (Value: "SEARCH_RESULT_MODE_UNSPECIFIED") + * The order in which documents are returned. Allowed values are: * "count + * desc", which means order by SearchResponse.Facet.values.count descending. * + * "value desc", which means order by SearchResponse.Facet.values.value + * descending. Only applies to textual facets. If not set, textual values are + * sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); + * numerical intervals are sorted in the order given by + * FacetSpec.FacetKey.intervals. */ -@property(nonatomic, copy, nullable) NSString *searchResultMode; +@property(nonatomic, copy, nullable) NSString *orderBy; /** - * If `snippetSpec` is not specified, snippets are not included in the search - * response. + * Only get facet values that start with the given string prefix. For example, + * suppose "category" has three values "Action > 2022", "Action > 2021" and + * "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only + * contains "Action > 2022" and "Action > 2021". Only supported on textual + * fields. Maximum is 10. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec *snippetSpec; +@property(nonatomic, strong, nullable) NSArray *prefixes; /** - * If `summarySpec` is not specified, summaries are not included in the search - * response. + * Only get facet for the given restricted values. Only supported on textual + * fields. For example, suppose "category" has three values "Action > 2022", + * "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > + * 2022", the "category" facet only contains "Action > 2022". Only supported on + * textual fields. Maximum is 10. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec *summarySpec; +@property(nonatomic, strong, nullable) NSArray *restrictedValues; @end /** - * Specifies the chunk spec to be returned from the search response. Only - * available if the SearchRequest.ContentSearchSpec.search_result_mode is set - * to CHUNKS - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec : GTLRObject - -/** - * The number of next chunks to be returned of the current chunk. The maximum - * allowed value is 3. If not specified, no next chunks will be returned. - * - * Uses NSNumber of intValue. + * Specifies the image query input. */ -@property(nonatomic, strong, nullable) NSNumber *numNextChunks; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery : GTLRObject /** - * The number of previous chunks to be returned of the current chunk. The - * maximum allowed value is 3. If not specified, no previous chunks will be - * returned. - * - * Uses NSNumber of intValue. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ -@property(nonatomic, strong, nullable) NSNumber *numPreviousChunks; +@property(nonatomic, copy, nullable) NSString *imageBytes; @end /** - * A specification for configuring the extractive content in a search response. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec : GTLRObject - -/** - * The maximum number of extractive answers returned in each search result. An - * extractive answer is a verbatim answer extracted from the original document, - * which provides a precise and contextually relevant answer to the search - * query. If the number of matching answers is less than the - * `max_extractive_answer_count`, return all of the answers. Otherwise, return - * the `max_extractive_answer_count`. At most five answers are returned for - * each SearchResult. - * - * Uses NSNumber of intValue. + * Specification to enable natural language understanding capabilities for + * search requests. */ -@property(nonatomic, strong, nullable) NSNumber *maxExtractiveAnswerCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec : GTLRObject /** - * The max number of extractive segments returned in each search result. Only - * applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED - * or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is - * a text segment extracted from the original document that is relevant to the - * search query, and, in general, more verbose than an extractive answer. The - * segment could then be used as input for LLMs to generate summaries and - * answers. If the number of matching segments is less than - * `max_extractive_segment_count`, return all of the segments. Otherwise, - * return the `max_extractive_segment_count`. - * - * Uses NSNumber of intValue. + * Optional. Allowlist of fields that can be used for natural language filter + * extraction. By default, if this is unspecified, all indexable fields are + * eligible for natural language filter extraction (but are not guaranteed to + * be used). If any fields are specified in allowed_field_names, only the + * fields that are both marked as indexable in the schema and specified in the + * allowlist will be eligible for natural language filter extraction. Note: for + * multi-datastore search, this is not yet supported, and will be ignored. */ -@property(nonatomic, strong, nullable) NSNumber *maxExtractiveSegmentCount; +@property(nonatomic, strong, nullable) NSArray *allowedFieldNames; /** - * Return at most `num_next_segments` segments after each selected segments. + * Optional. Controls behavior of how extracted filters are applied to the + * search. The default behavior depends on the request. For single datastore + * structured search, the default is `HARD_FILTER`. For multi-datastore search, + * the default behavior is `SOFT_BOOST`. Location-based filters are always + * applied as hard filters, and the `SOFT_BOOST` setting will not affect them. + * This field is only used if + * SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition + * is set to FilterExtractionCondition.ENABLED. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified + * `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior + * for extracted filters. For single datastore search, the default is to + * apply as hard filters. For multi-datastore search, the default is to + * apply as soft boosts. (Value: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter + * Applies all extracted filters as hard filters on the results. Results + * that do not pass the extracted filters will not be returned in the + * result set. (Value: "HARD_FILTER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost + * Applies all extracted filters as soft boosts. Results that pass the + * filters will be boosted up to higher ranks in the result set. (Value: + * "SOFT_BOOST") */ -@property(nonatomic, strong, nullable) NSNumber *numNextSegments; +@property(nonatomic, copy, nullable) NSString *extractedFilterBehavior; /** - * Specifies whether to also include the adjacent from each selected segments. - * Return at most `num_previous_segments` segments before each selected - * segments. + * The condition under which filter extraction should occur. Server behavior + * defaults to `DISABLED`. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified + * Server behavior defaults to `DISABLED`. (Value: + * "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled + * Disables NL filter extraction. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled + * Enables NL filter extraction. (Value: "ENABLED") */ -@property(nonatomic, strong, nullable) NSNumber *numPreviousSegments; +@property(nonatomic, copy, nullable) NSString *filterExtractionCondition; /** - * Specifies whether to return the confidence score from the extractive - * segments in each search result. This feature is available only for new or - * allowlisted data stores. To allowlist your data store, contact your Customer - * Engineer. The default value is `false`. - * - * Uses NSNumber of boolValue. + * Field names used for location-based filtering, where geolocation filters are + * detected in natural language search queries. Only valid when the + * FilterExtractionCondition is set to `ENABLED`. If this field is set, it + * overrides the field names set in + * ServingConfig.geo_search_query_detection_field_names. */ -@property(nonatomic, strong, nullable) NSNumber *returnExtractiveSegmentScore; +@property(nonatomic, strong, nullable) NSArray *geoSearchQueryDetectionFieldNames; @end /** - * A specification for configuring snippets in a search response. + * The specification for personalization. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec : GTLRObject /** - * [DEPRECATED] This field is deprecated. To control snippet return, use - * `return_snippet` field. For backwards compatibility, we will return snippet - * if max_snippet_count > 0. + * The personalization mode of the search request. Defaults to Mode.AUTO. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec_Mode_Auto + * Personalization is enabled if data quality requirements are met. + * (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec_Mode_Disabled + * Disable personalization. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec_Mode_ModeUnspecified + * Default value. In this case, server behavior defaults to Mode.AUTO. + * (Value: "MODE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *maxSnippetCount GTLR_DEPRECATED; +@property(nonatomic, copy, nullable) NSString *mode; + +@end + /** - * [DEPRECATED] This field is deprecated and will have no affect on the - * snippet. + * Specification to determine under which conditions query expansion should + * occur. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec : GTLRObject + +/** + * The condition under which query expansion should occur. Default to + * Condition.DISABLED. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec_Condition_Auto + * Automatic query expansion built by the Search API. (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec_Condition_ConditionUnspecified + * Unspecified query expansion condition. In this case, server behavior + * defaults to Condition.DISABLED. (Value: "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec_Condition_Disabled + * Disabled query expansion. Only the exact search query is used, even if + * SearchResponse.total_size is zero. (Value: "DISABLED") */ -@property(nonatomic, strong, nullable) NSNumber *referenceOnly GTLR_DEPRECATED; +@property(nonatomic, copy, nullable) NSString *condition; /** - * If `true`, then return snippet. If no snippet can be generated, we return - * "No snippet is available for this page." A `snippet_status` with `SUCCESS` - * or `NO_SNIPPET_AVAILABLE` will also be returned. + * Whether to pin unexpanded results. If this field is set to true, unexpanded + * products are always at the top of the search results, followed by the + * expanded results. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *returnSnippet; +@property(nonatomic, strong, nullable) NSNumber *pinUnexpandedResults; @end /** - * A specification for configuring a summary returned in a search response. + * The specification for returning the document relevance score. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec : GTLRObject /** - * Specifies whether to filter out adversarial queries. The default value is - * `false`. Google employs search-query classification to detect adversarial - * queries. No summary is returned if the search query is classified as an - * adversarial query. For example, a user might ask a question regarding - * negative comments about the company or submit a query designed to generate - * unsafe, policy-violating output. If this field is set to `true`, we skip - * generating summaries for adversarial queries and return fallback messages - * instead. + * Optional. Whether to return the relevance score for search results. The + * higher the score, the more relevant the document is to the query. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *ignoreAdversarialQuery; +@property(nonatomic, strong, nullable) NSNumber *returnRelevanceScore; -/** - * Optional. Specifies whether to filter out jail-breaking queries. The default - * value is `false`. Google employs search-query classification to detect - * jail-breaking queries. No summary is returned if the search query is - * classified as a jail-breaking query. A user might add instructions to the - * query to change the tone, style, language, content of the answer, or ask the - * model to act as a different entity, e.g. "Reply in the tone of a competing - * company's CEO". If this field is set to `true`, we skip generating summaries - * for jail-breaking queries and return fallback messages instead. - * - * Uses NSNumber of boolValue. +@end + + +/** + * SearchAddonSpec is used to disable add-ons for search as per new repricing + * model. By default if the SearchAddonSpec is not specified, we consider that + * the customer wants to enable them wherever applicable. */ -@property(nonatomic, strong, nullable) NSNumber *ignoreJailBreakingQuery; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec : GTLRObject /** - * Specifies whether to filter out queries that have low relevance. The default - * value is `false`. If this field is set to `false`, all search results are - * used regardless of relevance to generate answers. If set to `true`, only - * queries with high relevance search results will generate answers. + * Optional. If true, generative answer add-on is disabled. Generative answer + * add-on includes natural language to filters and simple answers. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *ignoreLowRelevantContent; +@property(nonatomic, strong, nullable) NSNumber *disableGenerativeAnswerAddOn; /** - * Specifies whether to filter out queries that are not summary-seeking. The - * default value is `false`. Google employs search-query classification to - * detect summary-seeking queries. No summary is returned if the search query - * is classified as a non-summary seeking query. For example, `why is the sky - * blue` and `Who is the best soccer player in the world?` are summary-seeking - * queries, but `SFO airport` and `world cup 2026` are not. They are most - * likely navigational queries. If this field is set to `true`, we skip - * generating summaries for non-summary seeking queries and return fallback - * messages instead. + * Optional. If true, disables event re-ranking and personalization to optimize + * KPIs & personalize results. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *ignoreNonSummarySeekingQuery; +@property(nonatomic, strong, nullable) NSNumber *disableKpiPersonalizationAddOn; /** - * Specifies whether to include citations in the summary. The default value is - * `false`. When this field is set to `true`, summaries include in-line - * citation numbers. Example summary including citations: BigQuery is Google - * Cloud's fully managed and completely serverless enterprise data warehouse - * [1]. BigQuery supports all data types, works across clouds, and has built-in - * machine learning and business intelligence, all within a unified platform - * [2, 3]. The citation numbers refer to the returned search results and are - * 1-indexed. For example, [1] means that the sentence is attributed to the - * first search result. [2, 3] means that the sentence is attributed to both - * the second and third search results. + * Optional. If true, semantic add-on is disabled. Semantic add-on includes + * embeddings and jetstream. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *includeCitations; +@property(nonatomic, strong, nullable) NSNumber *disableSemanticAddOn; + +@end + /** - * Language code for Summary. Use language tags defined by - * [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an - * experimental feature. + * Specification for search as you type in search requests. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec : GTLRObject /** - * If specified, the spec will be used to modify the prompt provided to the - * LLM. + * The condition under which search as you type should occur. Default to + * Condition.DISABLED. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_Auto + * Automatic switching between search-as-you-type and standard search + * modes, ideal for single-API implementations (e.g., debouncing). + * (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_ConditionUnspecified + * Server behavior defaults to Condition.DISABLED. (Value: + * "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_Disabled + * Disables Search As You Type. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_Enabled + * Enables Search As You Type. (Value: "ENABLED") */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec *modelPromptSpec; +@property(nonatomic, copy, nullable) NSString *condition; + +@end + /** - * If specified, the spec will be used to modify the model specification - * provided to the LLM. + * Session specification. Multi-turn Search feature is currently at private GA + * stage. Please use v1alpha or v1beta version instead before we launch this + * feature to public GA. Or ask for allowlisting through Google Support team. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec *modelSpec; - -/** Optional. Multimodal specification. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec *multimodalSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec : GTLRObject /** - * The number of top results to generate the summary from. If the number of - * results returned is less than `summaryResultCount`, the summary is generated - * from all of the results. At most 10 results for documents mode, or 50 for - * chunks mode, can be used to generate a summary. The chunks mode is used when - * SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. - * - * Uses NSNumber of intValue. + * If set, the search result gets stored to the "turn" specified by this query + * ID. Example: Let's say the session looks like this: session { name: + * ".../sessions/xxx" turns { query { text: "What is foo?" query_id: + * ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How + * about bar then?" query_id: ".../questions/zzz" } } } The user can call + * /search API with a request like this: session: ".../sessions/xxx" + * session_spec { query_id: ".../questions/zzz" } Then, the API stores the + * search result, associated with the last turn. The stored search result can + * be used by a subsequent /answer API call (with the session ID and the query + * ID specified). Also, it is possible to call /search and /answer in parallel + * with the same session ID & query ID. */ -@property(nonatomic, strong, nullable) NSNumber *summaryResultCount; +@property(nonatomic, copy, nullable) NSString *queryId; /** - * If true, answer will be generated from most relevant chunks from top search - * results. This feature will improve summary quality. Note that with this - * feature enabled, not all top search results will be referenced and included - * in the reference list, so the citation source index only points to the - * search results listed in the reference list. + * The number of top search results to persist. The persisted search results + * can be used for the subsequent /answer api call. This field is similar to + * the `summary_result_count` field in + * SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 + * results for documents mode, or 50 for chunks mode. * - * Uses NSNumber of boolValue. + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *useSemanticChunks; +@property(nonatomic, strong, nullable) NSNumber *searchResultPersistenceCount; @end /** - * Specification of the prompt to use with the model. + * The specification for query spell correction. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec : GTLRObject /** - * Text at the beginning of the prompt that instructs the assistant. Examples - * are available in the user guide. + * The mode under which spell correction replaces the original search query. + * Defaults to Mode.AUTO. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec_Mode_Auto + * Automatic spell correction built by the Search API. Search will be + * based on the corrected query if found. (Value: "AUTO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec_Mode_ModeUnspecified + * Unspecified spell correction mode. In this case, server behavior + * defaults to Mode.AUTO. (Value: "MODE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec_Mode_SuggestionOnly + * Search API tries to find a spelling suggestion. If a suggestion is + * found, it is put in the SearchResponse.corrected_query. The spelling + * suggestion won't be used as the search query. (Value: + * "SUGGESTION_ONLY") */ -@property(nonatomic, copy, nullable) NSString *preamble; +@property(nonatomic, copy, nullable) NSString *mode; @end /** - * Specification of the model. + * Metadata related to the progress of the + * CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The model version used to generate the summary. Supported values are: * - * `stable`: string. Default value when no value is specified. Uses a generally - * available, fine-tuned model. For more information, see [Answer generation - * model versions and - * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). - * * `preview`: string. (Public preview) Uses a preview model. For more - * information, see [Answer generation model versions and - * lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *version; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Multimodal specification: Will return an image from specified source. If - * multiple sources are specified, the pick is a quality based decision. + * Response message for CrawlRateManagementService.SetDedicatedCrawlRate + * method. It simply returns the state of the response, and an error message if + * the state is FAILED. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse : GTLRObject + +/** Errors from service when handling the request. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; /** - * Optional. Source of image returned in the answer. + * Output only. The state of the response. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_AllAvailableSources - * Behavior when service determines the pick from all available sources. - * (Value: "ALL_AVAILABLE_SOURCES") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_CorpusImageOnly - * Includes image from corpus in the answer. (Value: "CORPUS_IMAGE_ONLY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_FigureGenerationOnly - * Triggers figure generation in the answer. (Value: - * "FIGURE_GENERATION_ONLY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec_ImageSource_ImageSourceUnspecified - * Unspecified image source (multimodal feature is disabled by default). - * (Value: "IMAGE_SOURCE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse_State_Failed + * The state is failed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse_State_StateUnspecified + * The state is unspecified. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse_State_Succeeded + * The state is successful. (Value: "SUCCEEDED") */ -@property(nonatomic, copy, nullable) NSString *imageSource; +@property(nonatomic, copy, nullable) NSString *state; @end /** - * A struct to define data stores to filter on in a search call and - * configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error - * is returned. + * Metadata for single-regional CMEKs. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSingleRegionKey : GTLRObject /** - * Optional. Boost specification to boost certain documents. For more - * information on boosting, see - * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + * Required. Single-regional kms key resource name which will be used to + * encrypt resources + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec *boostSpec; +@property(nonatomic, copy, nullable) NSString *kmsKey; + +@end -/** - * Optional. Custom search operators which if specified will be used to filter - * results from workspace data stores. For more information on custom search - * operators, see - * [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). - */ -@property(nonatomic, copy, nullable) NSString *customSearchOperators; /** - * Required. Full resource name of DataStore, such as - * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - * The path must include the project number, project id is not supported for - * this field. + * A sitemap for the SiteSearchEngine. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSitemap : GTLRObject + +/** Output only. The sitemap's creation time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. Filter specification to filter documents in the data store - * specified by data_store field. For more information on filtering, see - * [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * Output only. The fully qualified resource name of the sitemap. `projects/ * + * /locations/ * /collections/ * /dataStores/ * /siteSearchEngine/sitemaps/ *` + * The `sitemap_id` suffix is system-generated. */ -@property(nonatomic, copy, nullable) NSString *filter; +@property(nonatomic, copy, nullable) NSString *name; + +/** Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. */ +@property(nonatomic, copy, nullable) NSString *uri; @end /** - * Specifies features for display, like match highlighting. + * Verification information for target sites in advanced site search. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo : GTLRObject /** - * The condition under which match highlighting should occur. + * Site verification state indicating the ownership and validity. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingConditionUnspecified - * Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`. (Value: - * "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingDisabled - * Disables match highlighting on all documents. (Value: - * "MATCH_HIGHLIGHTING_DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec_MatchHighlightingCondition_MatchHighlightingEnabled - * Enables match highlighting on all documents. (Value: - * "MATCH_HIGHLIGHTING_ENABLED") - */ -@property(nonatomic, copy, nullable) NSString *matchHighlightingCondition; - -@end - - -/** - * The specification that uses customized query embedding vector to do semantic - * document retrieval. + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_Exempted + * Site exempt from verification, e.g., a public website that opens to + * all. (Value: "EXEMPTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_SiteVerificationStateUnspecified + * Defaults to VERIFIED. (Value: "SITE_VERIFICATION_STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_Unverified + * Site ownership pending verification or verification failed. (Value: + * "UNVERIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_Verified + * Site ownership verified. (Value: "VERIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *siteVerificationState; -/** The embedding vector used for retrieval. Limit to 1. */ -@property(nonatomic, strong, nullable) NSArray *embeddingVectors; +/** Latest site verification time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *verifyTime; @end /** - * Embedding vector. + * A target site for the SiteSearchEngine. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector : GTLRObject - -/** Embedding field path in schema. */ -@property(nonatomic, copy, nullable) NSString *fieldPath; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite : GTLRObject /** - * Query embedding vector. + * Immutable. If set to false, a uri_pattern is generated to include all pages + * whose address contains the provided_uri_pattern. If set to true, an + * uri_pattern is generated to try to be an exact match of the + * provided_uri_pattern or just the specific page if the provided_uri_pattern + * is a specific one. provided_uri_pattern is always normalized to generate the + * URI pattern to be used by the search engine. * - * Uses NSNumber of floatValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *vector; - -@end +@property(nonatomic, strong, nullable) NSNumber *exactMatch; +/** Output only. Failure reason. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason *failureReason; /** - * A facet specification to perform faceted search. + * Output only. This is system-generated based on the provided_uri_pattern. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *generatedUriPattern; /** - * Enables dynamic position for this facet. If set to true, the position of - * this facet among all facets in the response is determined automatically. If - * dynamic facets are enabled, it is ordered together. If set to false, the - * position of this facet in the response is the same as in the request, and it - * is ranked before the facets with dynamic position enable and all dynamic - * facets. For example, you may always want to have rating facet returned in - * the response, but it's not necessarily to always display the rating facet at - * the top. In that case, you can set enable_dynamic_position to true so that - * the position of rating facet in response is determined automatically. - * Another example, assuming you have the following facets in the request: * - * "rating", enable_dynamic_position = true * "price", enable_dynamic_position - * = false * "brands", enable_dynamic_position = false And also you have a - * dynamic facets enabled, which generates a facet `gender`. Then the final - * order of the facets in the response can be ("price", "brands", "rating", - * "gender") or ("price", "brands", "gender", "rating") depends on how API - * orders "gender" and "rating" facets. However, notice that "price" and - * "brands" are always ranked at first and second position because their - * enable_dynamic_position is false. + * Output only. Indexing status. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Cancellable + * The target site change is pending but cancellable. (Value: + * "CANCELLABLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Cancelled + * The target site change is cancelled. (Value: "CANCELLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Deleting + * The previously indexed target site has been marked to be deleted. This + * is a transitioning state which will resulted in either: 1. target site + * deleted if unindexing is successful; 2. state reverts to SUCCEEDED if + * the unindexing fails. (Value: "DELETING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Failed + * The target site fails to be indexed. (Value: "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_IndexingStatusUnspecified + * Defaults to SUCCEEDED. (Value: "INDEXING_STATUS_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Pending + * The target site is in the update queue and will be picked up by + * indexing pipeline. (Value: "PENDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Succeeded + * The target site has been indexed. (Value: "SUCCEEDED") */ -@property(nonatomic, strong, nullable) NSNumber *enableDynamicPosition; +@property(nonatomic, copy, nullable) NSString *indexingStatus; /** - * List of keys to exclude when faceting. By default, FacetKey.key is not - * excluded from the filter unless it is listed in this field. Listing a facet - * key in this field allows its values to appear as facet results, even when - * they are filtered out of search results. Using this field does not affect - * what search results are returned. For example, suppose there are 100 - * documents with the color facet "Red" and 200 documents with the color facet - * "Blue". A query containing the filter "color:ANY("Red")" and having "color" - * as FacetKey.key would by default return only "Red" documents in the search - * results, and also return "Red" with count 100 as the only color facet. - * Although there are also blue documents available, "Blue" would not be shown - * as an available facet value. If "color" is listed in "excludedFilterKeys", - * then the query returns the facet values "Red" with count 100 and "Blue" with - * count 200, because the "color" key is now excluded from the filter. Because - * this field doesn't affect search results, the search results are still - * correctly filtered to return only "Red" documents. A maximum of 100 values - * are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Output only. The fully qualified resource name of the target site. + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + * The `target_site_id` is system-generated. */ -@property(nonatomic, strong, nullable) NSArray *excludedFilterKeys; - -/** Required. The facet key specification. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey *facetKey; +@property(nonatomic, copy, nullable) NSString *name; /** - * Maximum facet values that are returned for this facet. If unspecified, - * defaults to 20. The maximum allowed value is 300. Values above 300 are - * coerced to 300. For aggregation in healthcare search, when the - * [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden - * to 10,000 internally, regardless of the value set here. If this field is - * negative, an `INVALID_ARGUMENT` is returned. - * - * Uses NSNumber of intValue. + * Required. Input only. The user provided URI pattern from which the + * `generated_uri_pattern` is generated. */ -@property(nonatomic, strong, nullable) NSNumber *limit; - -@end +@property(nonatomic, copy, nullable) NSString *providedUriPattern; +/** Output only. Root domain of the provided_uri_pattern. */ +@property(nonatomic, copy, nullable) NSString *rootDomainUri; -/** - * Specifies how a facet is computed. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey : GTLRObject +/** Output only. Site ownership and validity verification status. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo *siteVerificationInfo; /** - * True to make facet keys case insensitive when getting faceting values with - * prefixes or contains; false otherwise. + * The type of the target site, e.g., whether the site is to be included or + * excluded. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_Type_Exclude + * Exclude the target site. (Value: "EXCLUDE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_Type_Include + * Include the target site. (Value: "INCLUDE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_Type_TypeUnspecified + * This value is unused. In this case, server behavior defaults to + * Type.INCLUDE. (Value: "TYPE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *caseInsensitive; +@property(nonatomic, copy, nullable) NSString *type; -/** - * Only get facet values that contain the given strings. For example, suppose - * "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > - * 2022". If set "contains" to "2022", the "category" facet only contains - * "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. - * Maximum is 10. - */ -@property(nonatomic, strong, nullable) NSArray *contains; +/** Output only. The target site's last updated time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** - * Set only if values should be bucketed into intervals. Must be set for facets - * with numerical values. Must not be set for facet with text values. Maximum - * number of intervals is 30. - */ -@property(nonatomic, strong, nullable) NSArray *intervals; +@end -/** - * Required. Supported textual and numerical facet keys in Document object, - * over which the facet values are computed. Facet key is case-sensitive. - */ -@property(nonatomic, copy, nullable) NSString *key; /** - * The order in which documents are returned. Allowed values are: * "count - * desc", which means order by SearchResponse.Facet.values.count descending. * - * "value desc", which means order by SearchResponse.Facet.values.value - * descending. Only applies to textual facets. If not set, textual values are - * sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); - * numerical intervals are sorted in the order given by - * FacetSpec.FacetKey.intervals. + * Site search indexing failure reasons. */ -@property(nonatomic, copy, nullable) NSString *orderBy; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason : GTLRObject + +/** Failed due to insufficient quota. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure *quotaFailure; + +@end + /** - * Only get facet values that start with the given string prefix. For example, - * suppose "category" has three values "Action > 2022", "Action > 2021" and - * "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only - * contains "Action > 2022" and "Action > 2021". Only supported on textual - * fields. Maximum is 10. + * Failed due to insufficient quota. */ -@property(nonatomic, strong, nullable) NSArray *prefixes; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure : GTLRObject /** - * Only get facet for the given restricted values. Only supported on textual - * fields. For example, suppose "category" has three values "Action > 2022", - * "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > - * 2022", the "category" facet only contains "Action > 2022". Only supported on - * textual fields. Maximum is 10. + * This number is an estimation on how much total quota this project needs to + * successfully complete indexing. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *restrictedValues; +@property(nonatomic, strong, nullable) NSNumber *totalRequiredQuota; @end /** - * Specifies the image query input. + * Metadata related to the progress of the TrainCustomModel operation. This is + * returned by the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *imageBytes; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Specification to enable natural language understanding capabilities for - * search requests. + * Response of the TrainCustomModelRequest. This message is returned by the + * google.longrunning.Operations.response field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse : GTLRObject + +/** Echoes the destination for the complete errors in the request if set. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; + +/** A sample of errors encountered while processing the data. */ +@property(nonatomic, strong, nullable) NSArray *errorSamples; + +/** The metrics of the trained model. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse_Metrics *metrics; + +/** Fully qualified name of the CustomTuningModel. */ +@property(nonatomic, copy, nullable) NSString *modelName; /** - * Optional. Controls behavior of how extracted filters are applied to the - * search. The default behavior depends on the request. For single datastore - * structured search, the default is `HARD_FILTER`. For multi-datastore search, - * the default behavior is `SOFT_BOOST`. Location-based filters are always - * applied as hard filters, and the `SOFT_BOOST` setting will not affect them. - * This field is only used if - * SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition - * is set to FilterExtractionCondition.ENABLED. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified - * `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior - * for extracted filters. For single datastore search, the default is to - * apply as hard filters. For multi-datastore search, the default is to - * apply as soft boosts. (Value: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter - * Applies all extracted filters as hard filters on the results. Results - * that do not pass the extracted filters will not be returned in the - * result set. (Value: "HARD_FILTER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost - * Applies all extracted filters as soft boosts. Results that pass the - * filters will be boosted up to higher ranks in the result set. (Value: - * "SOFT_BOOST") + * The trained model status. Possible values are: * **bad-data**: The training + * data quality is bad. * **no-improvement**: Tuning didn't improve + * performance. Won't deploy. * **in-progress**: Model training job creation is + * in progress. * **training**: Model is actively training. * **evaluating**: + * The model is evaluating trained metrics. * **indexing**: The model trained + * metrics are indexing. * **ready**: The model is ready for serving. */ -@property(nonatomic, copy, nullable) NSString *extractedFilterBehavior; +@property(nonatomic, copy, nullable) NSString *modelStatus; + +@end + /** - * The condition under which filter extraction should occur. Server behavior - * defaults to `DISABLED`. + * The metrics of the trained model. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified - * Server behavior defaults to `DISABLED`. (Value: - * "CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled - * Disables NL filter extraction. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled - * Enables NL filter extraction. (Value: "ENABLED") + * @note This class is documented as having more properties of NSNumber (Uses + * NSNumber of doubleValue.). Use @c -additionalJSONKeys and @c + * -additionalPropertyForName: to get the list of properties and then + * fetch them; or @c -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *filterExtractionCondition; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse_Metrics : GTLRObject +@end + /** - * Field names used for location-based filtering, where geolocation filters are - * detected in natural language search queries. Only valid when the - * FilterExtractionCondition is set to `ENABLED`. If this field is set, it - * overrides the field names set in - * ServingConfig.geo_search_query_detection_field_names. + * Metadata associated with a tune operation. */ -@property(nonatomic, strong, nullable) NSArray *geoSearchQueryDetectionFieldNames; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTuneEngineMetadata : GTLRObject + +/** + * Required. The resource name of the engine that this tune applies to. Format: + * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + */ +@property(nonatomic, copy, nullable) NSString *engine; @end /** - * The specification for personalization. + * Response associated with a tune operation. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTuneEngineResponse : GTLRObject +@end + /** - * The personalization mode of the search request. Defaults to Mode.AUTO. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec_Mode_Auto - * Personalization is enabled if data quality requirements are met. - * (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec_Mode_Disabled - * Disable personalization. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec_Mode_ModeUnspecified - * Default value. In this case, server behavior defaults to Mode.AUTO. - * (Value: "MODE_UNSPECIFIED") + * Metadata for UpdateSchema LRO. */ -@property(nonatomic, copy, nullable) NSString *mode; - -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata : GTLRObject +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Specification to determine under which conditions query expansion should - * occur. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec : GTLRObject +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + /** - * The condition under which query expansion should occur. Default to - * Condition.DISABLED. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec_Condition_Auto - * Automatic query expansion built by the Search API. (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec_Condition_ConditionUnspecified - * Unspecified query expansion condition. In this case, server behavior - * defaults to Condition.DISABLED. (Value: "CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec_Condition_Disabled - * Disabled query expansion. Only the exact search query is used, even if - * SearchResponse.total_size is zero. (Value: "DISABLED") + * Metadata related to the progress of the + * SiteSearchEngineService.UpdateTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *condition; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Whether to pin unexpanded results. If this field is set to true, unexpanded - * products are always at the top of the search results, followed by the - * expanded results. - * - * Uses NSNumber of boolValue. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSNumber *pinUnexpandedResults; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * The specification for returning the document relevance score. + * Information of an end user. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserInfo : GTLRObject + +/** Optional. IANA time zone, e.g. Europe/Budapest. */ +@property(nonatomic, copy, nullable) NSString *timeZone; /** - * Optional. Whether to return the relevance score for search results. The - * higher the score, the more relevant the document is to the query. - * - * Uses NSNumber of boolValue. + * User agent as included in the HTTP header. The field must be a UTF-8 encoded + * string with a length limit of 1,000 characters. Otherwise, an + * `INVALID_ARGUMENT` error is returned. This should not be set when using the + * client side event reporting with GTM or JavaScript tag in + * UserEventService.CollectUserEvent or if UserEvent.direct_user_request is + * set. */ -@property(nonatomic, strong, nullable) NSNumber *returnRelevanceScore; +@property(nonatomic, copy, nullable) NSString *userAgent; + +/** + * Highly recommended for logged-in users. Unique identifier for logged-in + * user, such as a user name. Don't set for anonymous users. Always use a + * hashed value for this ID. Don't set the field to the same fixed ID for + * different users. This mixes the event history of those users together, which + * results in degraded model quality. The field must be a UTF-8 encoded string + * with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` + * error is returned. + */ +@property(nonatomic, copy, nullable) NSString *userId; @end /** - * Specification for search as you type in search requests. + * User License information assigned by the admin. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense : GTLRObject + +/** Output only. User created timestamp. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The condition under which search as you type should occur. Default to - * Condition.DISABLED. + * Output only. User last logged in time. If the user has not logged in yet, + * this field will be empty. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *lastLoginTime; + +/** + * Output only. License assignment state of the user. If the user is assigned + * with a license config, the user login will be assigned with the license; If + * the user's license assignment state is unassigned or unspecified, no license + * config will be associated to the user; * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_Auto - * Automatic switching between search-as-you-type and standard search - * modes, ideal for single-API implementations (e.g., debouncing). - * (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_ConditionUnspecified - * Server behavior defaults to Condition.DISABLED. (Value: - * "CONDITION_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_Disabled - * Disables Search As You Type. (Value: "DISABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec_Condition_Enabled - * Enables Search As You Type. (Value: "ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_Assigned + * License assigned to the user. (Value: "ASSIGNED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_Blocked + * User is blocked from assigning a license. (Value: "BLOCKED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_LicenseAssignmentStateUnspecified + * Default value. (Value: "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_NoLicense + * No license assigned to the user. (Value: "NO_LICENSE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_NoLicenseAttemptedLogin + * User attempted to login but no license assigned to the user. This + * state is only used for no user first time login attempt but cannot get + * license assigned. Users already logged in but cannot get license + * assigned will be assigned NO_LICENSE state(License could be unassigned + * by admin). (Value: "NO_LICENSE_ATTEMPTED_LOGIN") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_Unassigned + * No license assigned to the user. Deprecated, translated to NO_LICENSE. + * (Value: "UNASSIGNED") */ -@property(nonatomic, copy, nullable) NSString *condition; +@property(nonatomic, copy, nullable) NSString *licenseAssignmentState; -@end +/** + * Optional. The full resource name of the Subscription(LicenseConfig) assigned + * to the user. + */ +@property(nonatomic, copy, nullable) NSString *licenseConfig; +/** Output only. User update timestamp. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; /** - * Session specification. Multi-turn Search feature is currently at private GA - * stage. Please use v1alpha or v1beta version instead before we launch this - * feature to public GA. Or ask for allowlisting through Google Support team. + * Required. Immutable. The user principal of the User, could be email address + * or other prinical identifier. This field is immutable. Admin assign licenses + * based on the user principal. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *userPrincipal; /** - * If set, the search result gets stored to the "turn" specified by this query - * ID. Example: Let's say the session looks like this: session { name: - * ".../sessions/xxx" turns { query { text: "What is foo?" query_id: - * ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How - * about bar then?" query_id: ".../questions/zzz" } } } The user can call - * /search API with a request like this: session: ".../sessions/xxx" - * session_spec { query_id: ".../questions/zzz" } Then, the API stores the - * search result, associated with the last turn. The stored search result can - * be used by a subsequent /answer API call (with the session ID and the query - * ID specified). Also, it is possible to call /search and /answer in parallel - * with the same session ID & query ID. + * Optional. The user profile. We user user full name(First name + Last name) + * as user profile. */ -@property(nonatomic, copy, nullable) NSString *queryId; +@property(nonatomic, copy, nullable) NSString *userProfile; + +@end + /** - * The number of top search results to persist. The persisted search results - * can be used for the subsequent /answer api call. This field is similar to - * the `summary_result_count` field in - * SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 - * results for documents mode, or 50 for chunks mode. - * - * Uses NSNumber of intValue. + * Config to store data store type configuration for workspace data */ -@property(nonatomic, strong, nullable) NSNumber *searchResultPersistenceCount; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig : GTLRObject -@end +/** Obfuscated Dasher customer ID. */ +@property(nonatomic, copy, nullable) NSString *dasherCustomerId; +/** + * Optional. The super admin email address for the workspace that will be used + * for access token generation. For now we only use it for Native Google Drive + * connector data ingestion. + */ +@property(nonatomic, copy, nullable) NSString *superAdminEmailAddress; /** - * The specification for query spell correction. + * Optional. The super admin service account for the workspace that will be + * used for access token generation. For now we only use it for Native Google + * Drive connector data ingestion. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *superAdminServiceAccount; /** - * The mode under which spell correction replaces the original search query. - * Defaults to Mode.AUTO. + * The Google Workspace data source. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec_Mode_Auto - * Automatic spell correction built by the Search API. Search will be - * based on the corrected query if found. (Value: "AUTO") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec_Mode_ModeUnspecified - * Unspecified spell correction mode. In this case, server behavior - * defaults to Mode.AUTO. (Value: "MODE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec_Mode_SuggestionOnly - * Search API tries to find a spelling suggestion. If a suggestion is - * found, it is put in the SearchResponse.corrected_query. The spelling - * suggestion won't be used as the search query. (Value: - * "SUGGESTION_ONLY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleCalendar + * Workspace Data Store contains Calendar data (Value: "GOOGLE_CALENDAR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleChat + * Workspace Data Store contains Chat data (Value: "GOOGLE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleDrive + * Workspace Data Store contains Drive data (Value: "GOOGLE_DRIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleGroups + * Workspace Data Store contains Groups data (Value: "GOOGLE_GROUPS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleKeep + * Workspace Data Store contains Keep data (Value: "GOOGLE_KEEP") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleMail + * Workspace Data Store contains Mail data (Value: "GOOGLE_MAIL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GooglePeople + * Workspace Data Store contains People data (Value: "GOOGLE_PEOPLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleSites + * Workspace Data Store contains Sites data (Value: "GOOGLE_SITES") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_TypeUnspecified + * Defaults to an unspecified Workspace type. (Value: "TYPE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *mode; +@property(nonatomic, copy, nullable) NSString *type; @end /** - * Metadata related to the progress of the - * CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be - * returned by the google.longrunning.Operation.metadata field. + * BigQuery source import data from. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigQuerySource : GTLRObject /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The schema to use when parsing the data from the source. Supported values + * for user event imports: * `user_event` (default): One UserEvent per row. + * Supported values for document imports: * `document` (default): One Document + * format per row. Each document must have a valid Document.id and one of + * Document.json_data or Document.struct_data. * `custom`: One custom data per + * row in arbitrary format that conforms to the defined Schema of the data + * store. This can only be used by the GENERIC Data Store vertical. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - +@property(nonatomic, copy, nullable) NSString *dataSchema; /** - * Response message for CrawlRateManagementService.SetDedicatedCrawlRate - * method. It simply returns the state of the response, and an error message if - * the state is FAILED. + * Required. The BigQuery data set to copy the data from with a length limit of + * 1,024 characters. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse : GTLRObject - -/** Errors from service when handling the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; +@property(nonatomic, copy, nullable) NSString *datasetId; /** - * Output only. The state of the response. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse_State_Failed - * The state is failed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse_State_StateUnspecified - * The state is unspecified. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse_State_Succeeded - * The state is successful. (Value: "SUCCEEDED") + * Intermediate Cloud Storage directory used for the import with a length limit + * of 2,000 characters. Can be specified if one wants to have the BigQuery + * export to a specific Cloud Storage directory. */ -@property(nonatomic, copy, nullable) NSString *state; - -@end +@property(nonatomic, copy, nullable) NSString *gcsStagingDir; +/** BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *partitionDate; /** - * Metadata for single-regional CMEKs. + * The project ID or the project number that contains the BigQuery source. Has + * a length limit of 128 characters. If not specified, inherits the project ID + * from the parent request. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSingleRegionKey : GTLRObject +@property(nonatomic, copy, nullable) NSString *projectId; /** - * Required. Single-regional kms key resource name which will be used to - * encrypt resources - * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + * Required. The BigQuery table to copy the data from with a length limit of + * 1,024 characters. */ -@property(nonatomic, copy, nullable) NSString *kmsKey; +@property(nonatomic, copy, nullable) NSString *tableId; @end /** - * A sitemap for the SiteSearchEngine. + * The Bigtable Options object that contains information to support the import. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSitemap : GTLRObject - -/** Output only. The sitemap's creation time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions : GTLRObject /** - * Output only. The fully qualified resource name of the sitemap. `projects/ * - * /locations/ * /collections/ * /dataStores/ * /siteSearchEngine/sitemaps/ *` - * The `sitemap_id` suffix is system-generated. + * The mapping from family names to an object that contains column families + * level information for the given column family. If a family is not present in + * this map it will be ignored. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions_Families *families; -/** Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`. */ -@property(nonatomic, copy, nullable) NSString *uri; +/** + * The field name used for saving row key value in the document. The name has + * to match the pattern `a-zA-Z0-9*`. + */ +@property(nonatomic, copy, nullable) NSString *keyFieldName; @end /** - * Verification information for target sites in advanced site search. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo : GTLRObject - -/** - * Site verification state indicating the ownership and validity. + * The mapping from family names to an object that contains column families + * level information for the given column family. If a family is not present in + * this map it will be ignored. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_Exempted - * Site exempt from verification, e.g., a public website that opens to - * all. (Value: "EXEMPTED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_SiteVerificationStateUnspecified - * Defaults to VERIFIED. (Value: "SITE_VERIFICATION_STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_Unverified - * Site ownership pending verification or verification failed. (Value: - * "UNVERIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo_SiteVerificationState_Verified - * Site ownership verified. (Value: "VERIFIED") + * @note This class is documented as having more properties of + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily. + * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get + * the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *siteVerificationState; - -/** Latest site verification time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *verifyTime; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions_Families : GTLRObject @end /** - * A target site for the SiteSearchEngine. + * The column of the Bigtable. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn : GTLRObject /** - * Immutable. If set to false, a uri_pattern is generated to include all pages - * whose address contains the provided_uri_pattern. If set to true, an - * uri_pattern is generated to try to be an exact match of the - * provided_uri_pattern or just the specific page if the provided_uri_pattern - * is a specific one. provided_uri_pattern is always normalized to generate the - * URI pattern to be used by the search engine. + * The encoding mode of the values when the type is not `STRING`. Acceptable + * encoding values are: * `TEXT`: indicates values are alphanumeric text + * strings. * `BINARY`: indicates values are encoded using `HBase + * Bytes.toBytes` family of functions. This can be overridden for a specific + * column by listing that column in `columns` and specifying an encoding for + * it. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Encoding_Binary + * Binary encoding. (Value: "BINARY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Encoding_EncodingUnspecified + * The encoding is unspecified. (Value: "ENCODING_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Encoding_Text + * Text encoding. (Value: "TEXT") */ -@property(nonatomic, strong, nullable) NSNumber *exactMatch; +@property(nonatomic, copy, nullable) NSString *encoding; -/** Output only. Failure reason. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason *failureReason; +/** + * The field name to use for this column in the document. The name has to match + * the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes + * with best effort. However, due to different naming patterns, field name + * collisions could happen, where parsing behavior is undefined. + */ +@property(nonatomic, copy, nullable) NSString *fieldName; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a + * base-64 encoded string instead. + * + * Contains encoded binary data; GTLRBase64 can encode/decode (probably + * web-safe format). */ -@property(nonatomic, copy, nullable) NSString *generatedUriPattern; +@property(nonatomic, copy, nullable) NSString *qualifier; /** - * Output only. Indexing status. + * The type of values in this column family. The values are expected to be + * encoded using `HBase Bytes.toBytes` function when the encoding value is set + * to `BINARY`. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Cancellable - * The target site change is pending but cancellable. (Value: - * "CANCELLABLE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Cancelled - * The target site change is cancelled. (Value: "CANCELLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Deleting - * The previously indexed target site has been marked to be deleted. This - * is a transitioning state which will resulted in either: 1. target site - * deleted if unindexing is successful; 2. state reverts to SUCCEEDED if - * the unindexing fails. (Value: "DELETING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Failed - * The target site fails to be indexed. (Value: "FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_IndexingStatusUnspecified - * Defaults to SUCCEEDED. (Value: "INDEXING_STATUS_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Pending - * The target site is in the update queue and will be picked up by - * indexing pipeline. (Value: "PENDING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_IndexingStatus_Succeeded - * The target site has been indexed. (Value: "SUCCEEDED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_BigNumeric + * BigDecimal type. (Value: "BIG_NUMERIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Boolean + * Boolean type. (Value: "BOOLEAN") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Integer + * Integer type. (Value: "INTEGER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Json + * JSON type. (Value: "JSON") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Number + * Numerical type. (Value: "NUMBER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_String + * String type. (Value: "STRING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_TypeUnspecified + * The type is unspecified. (Value: "TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_VarInteger + * Variable length integer type. (Value: "VAR_INTEGER") */ -@property(nonatomic, copy, nullable) NSString *indexingStatus; +@property(nonatomic, copy, nullable) NSString *type; + +@end + /** - * Output only. The fully qualified resource name of the target site. - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - * The `target_site_id` is system-generated. + * The column family of the Bigtable. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily : GTLRObject /** - * Required. Input only. The user provided URI pattern from which the - * `generated_uri_pattern` is generated. + * The list of objects that contains column level information for each column. + * If a column is not present in this list it will be ignored. */ -@property(nonatomic, copy, nullable) NSString *providedUriPattern; +@property(nonatomic, strong, nullable) NSArray *columns; -/** Output only. Root domain of the provided_uri_pattern. */ -@property(nonatomic, copy, nullable) NSString *rootDomainUri; +/** + * The encoding mode of the values when the type is not STRING. Acceptable + * encoding values are: * `TEXT`: indicates values are alphanumeric text + * strings. * `BINARY`: indicates values are encoded using `HBase + * Bytes.toBytes` family of functions. This can be overridden for a specific + * column by listing that column in `columns` and specifying an encoding for + * it. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Encoding_Binary + * Binary encoding. (Value: "BINARY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Encoding_EncodingUnspecified + * The encoding is unspecified. (Value: "ENCODING_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Encoding_Text + * Text encoding. (Value: "TEXT") + */ +@property(nonatomic, copy, nullable) NSString *encoding; -/** Output only. Site ownership and validity verification status. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaSiteVerificationInfo *siteVerificationInfo; +/** + * The field name to use for this column family in the document. The name has + * to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family + * name with best effort. However, due to different naming patterns, field name + * collisions could happen, where parsing behavior is undefined. + */ +@property(nonatomic, copy, nullable) NSString *fieldName; /** - * The type of the target site, e.g., whether the site is to be included or - * excluded. + * The type of values in this column family. The values are expected to be + * encoded using `HBase Bytes.toBytes` function when the encoding value is set + * to `BINARY`. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_Type_Exclude - * Exclude the target site. (Value: "EXCLUDE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_Type_Include - * Include the target site. (Value: "INCLUDE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSite_Type_TypeUnspecified - * This value is unused. In this case, server behavior defaults to - * Type.INCLUDE. (Value: "TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_BigNumeric + * BigDecimal type. (Value: "BIG_NUMERIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Boolean + * Boolean type. (Value: "BOOLEAN") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Integer + * Integer type. (Value: "INTEGER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Json + * JSON type. (Value: "JSON") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Number + * Numerical type. (Value: "NUMBER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_String + * String type. (Value: "STRING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_TypeUnspecified + * The type is unspecified. (Value: "TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_VarInteger + * Variable length integer type. (Value: "VAR_INTEGER") */ @property(nonatomic, copy, nullable) NSString *type; -/** Output only. The target site's last updated time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - @end /** - * Site search indexing failure reasons. + * The Cloud Bigtable source for importing data. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason : GTLRObject - -/** Failed due to insufficient quota. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure *quotaFailure; - -@end - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableSource : GTLRObject /** - * Failed due to insufficient quota. + * Required. Bigtable options that contains information needed when parsing + * data into typed structures. For example, column type annotations. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure : GTLRObject +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions *bigtableOptions; /** - * This number is an estimation on how much total quota this project needs to - * successfully complete indexing. - * - * Uses NSNumber of longLongValue. + * Required. The instance ID of the Cloud Bigtable that needs to be imported. */ -@property(nonatomic, strong, nullable) NSNumber *totalRequiredQuota; - -@end - +@property(nonatomic, copy, nullable) NSString *instanceId; /** - * Metadata related to the progress of the TrainCustomModel operation. This is - * returned by the google.longrunning.Operation.metadata field. + * The project ID that contains the Bigtable source. Has a length limit of 128 + * characters. If not specified, inherits the project ID from the parent + * request. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, copy, nullable) NSString *projectId; -/** - * Operation last update time. If the operation is done, this is also the - * finish time. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +/** Required. The table ID of the Cloud Bigtable that needs to be imported. */ +@property(nonatomic, copy, nullable) NSString *tableId; @end /** - * Response of the TrainCustomModelRequest. This message is returned by the - * google.longrunning.Operations.response field. + * Request message for GroundedGenerationService.CheckGrounding method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse : GTLRObject - -/** Echoes the destination for the complete errors in the request if set. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaImportErrorConfig *errorConfig; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingRequest : GTLRObject -/** A sample of errors encountered while processing the data. */ -@property(nonatomic, strong, nullable) NSArray *errorSamples; +/** Answer candidate to check. It can have a maximum length of 4096 tokens. */ +@property(nonatomic, copy, nullable) NSString *answerCandidate; -/** The metrics of the trained model. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse_Metrics *metrics; +/** List of facts for the grounding check. We support up to 200 facts. */ +@property(nonatomic, strong, nullable) NSArray *facts; -/** Fully qualified name of the CustomTuningModel. */ -@property(nonatomic, copy, nullable) NSString *modelName; +/** Configuration of the grounding check. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingSpec *groundingSpec; /** - * The trained model status. Possible values are: * **bad-data**: The training - * data quality is bad. * **no-improvement**: Tuning didn't improve - * performance. Won't deploy. * **in-progress**: Model training job creation is - * in progress. * **training**: Model is actively training. * **evaluating**: - * The model is evaluating trained metrics. * **indexing**: The model trained - * metrics are indexing. * **ready**: The model is ready for serving. + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. */ -@property(nonatomic, copy, nullable) NSString *modelStatus; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingRequest_UserLabels *userLabels; @end /** - * The metrics of the trained model. + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. * - * @note This class is documented as having more properties of NSNumber (Uses - * NSNumber of doubleValue.). Use @c -additionalJSONKeys and @c - * -additionalPropertyForName: to get the list of properties and then - * fetch them; or @c -additionalProperties to fetch them all at once. + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse_Metrics : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingRequest_UserLabels : GTLRObject @end /** - * Metadata associated with a tune operation. + * Response message for the GroundedGenerationService.CheckGrounding method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTuneEngineMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingResponse : GTLRObject /** - * Required. The resource name of the engine that this tune applies to. Format: - * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + * List of facts cited across all claims in the answer candidate. These are + * derived from the facts supplied in the request. */ -@property(nonatomic, copy, nullable) NSString *engine; - -@end - +@property(nonatomic, strong, nullable) NSArray *citedChunks; /** - * Response associated with a tune operation. + * List of facts cited across all claims in the answer candidate. These are + * derived from the facts supplied in the request. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaTuneEngineResponse : GTLRObject -@end - +@property(nonatomic, strong, nullable) NSArray *citedFacts; /** - * Metadata for UpdateSchema LRO. + * Claim texts and citation info across all claims in the answer candidate. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) NSArray *claims; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * The support score for the input answer candidate. Higher the score, higher + * is the fraction of claims that are supported by the provided facts. This is + * always set when a response is returned. + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSNumber *supportScore; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.UpdateTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Fact chunk for grounding check. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk : GTLRObject + +/** Text content of the fact chunk. Can be at most 10K characters long. */ +@property(nonatomic, copy, nullable) NSString *chunkText; + +@end -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Text and citation info for a claim in the answer candidate. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim : GTLRObject -@end +/** + * A list of indices (into 'cited_chunks') specifying the citations associated + * with the claim. For instance [1,3,4] means that cited_chunks[1], + * cited_chunks[3], cited_chunks[4] are the facts cited supporting for the + * claim. A citation to a fact indicates that the claim is supported by the + * fact. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSArray *citationIndices; +/** + * Text for the claim in the answer candidate. Always provided regardless of + * whether citations or anti-citations are found. + */ +@property(nonatomic, copy, nullable) NSString *claimText; /** - * Information of an end user. + * Position indicating the end of the claim in the answer candidate, exclusive, + * in bytes. Note that this is not measured in characters and, therefore, must + * be rendered as such. For example, if the claim text contains non-ASCII + * characters, the start and end positions vary when measured in characters + * (programming-language-dependent) and when measured in bytes + * (programming-language-independent). + * + * Uses NSNumber of intValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserInfo : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *endPos; -/** Optional. IANA time zone, e.g. Europe/Budapest. */ -@property(nonatomic, copy, nullable) NSString *timeZone; +/** + * Indicates that this claim required grounding check. When the system decided + * this claim doesn't require attribution/grounding check, this field will be + * set to false. In that case, no grounding check was done for the claim and + * therefore citation_indices should not be returned. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *groundingCheckRequired; /** - * User agent as included in the HTTP header. The field must be a UTF-8 encoded - * string with a length limit of 1,000 characters. Otherwise, an - * `INVALID_ARGUMENT` error is returned. This should not be set when using the - * client side event reporting with GTM or JavaScript tag in - * UserEventService.CollectUserEvent or if UserEvent.direct_user_request is - * set. + * Confidence score for the claim in the answer candidate, in the range of [0, + * 1]. This is set only when + * `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, copy, nullable) NSString *userAgent; +@property(nonatomic, strong, nullable) NSNumber *score; /** - * Highly recommended for logged-in users. Unique identifier for logged-in - * user, such as a user name. Don't set for anonymous users. Always use a - * hashed value for this ID. Don't set the field to the same fixed ID for - * different users. This mixes the event history of those users together, which - * results in degraded model quality. The field must be a UTF-8 encoded string - * with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` - * error is returned. + * Position indicating the start of the claim in the answer candidate, measured + * in bytes. Note that this is not measured in characters and, therefore, must + * be rendered in the user interface keeping in mind that some characters may + * take more than one byte. For example, if the claim text contains non-ASCII + * characters, the start and end positions vary when measured in characters + * (programming-language-dependent) and when measured in bytes + * (programming-language-independent). + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *userId; +@property(nonatomic, strong, nullable) NSNumber *startPos; @end /** - * User License information assigned by the admin. + * Specification for the grounding check. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense : GTLRObject - -/** Output only. User created timestamp. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingSpec : GTLRObject /** - * Output only. User last logged in time. If the user has not logged in yet, - * this field will be empty. + * The threshold (in [0,1]) used for determining whether a fact must be cited + * for a claim in the answer candidate. Choosing a higher threshold will lead + * to fewer but very strong citations, while choosing a lower threshold may + * lead to more but somewhat weaker citations. If unset, the threshold will + * default to 0.6. + * + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *lastLoginTime; +@property(nonatomic, strong, nullable) NSNumber *citationThreshold; /** - * Output only. License assignment state of the user. If the user is assigned - * with a license config, the user login will be assigned with the license; If - * the user's license assignment state is unassigned or unspecified, no license - * config will be associated to the user; + * The control flag that enables claim-level grounding score in the response. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_Assigned - * License assigned to the user. (Value: "ASSIGNED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_Blocked - * User is blocked from assigning a license. (Value: "BLOCKED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_LicenseAssignmentStateUnspecified - * Default value. (Value: "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_NoLicense - * No license assigned to the user. (Value: "NO_LICENSE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_NoLicenseAttemptedLogin - * User attempted to login but no license assigned to the user. This - * state is only used for no user first time login attempt but cannot get - * license assigned. Users already logged in but cannot get license - * assigned will be assigned NO_LICENSE state(License could be unassigned - * by admin). (Value: "NO_LICENSE_ATTEMPTED_LOGIN") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaUserLicense_LicenseAssignmentState_Unassigned - * No license assigned to the user. Deprecated, translated to NO_LICENSE. - * (Value: "UNASSIGNED") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *licenseAssignmentState; +@property(nonatomic, strong, nullable) NSNumber *enableClaimLevelScore; + +@end + /** - * Optional. The full resource name of the Subscription(LicenseConfig) assigned - * to the user. + * Chunk captures all raw metadata information of items to be recommended or + * searched in the chunk mode. */ -@property(nonatomic, copy, nullable) NSString *licenseConfig; - -/** Output only. User update timestamp. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Chunk : GTLRObject /** - * Required. Immutable. The user principal of the User, could be email address - * or other prinical identifier. This field is immutable. Admin assign licenses - * based on the user principal. + * Output only. Annotation contents if the current chunk contains annotations. */ -@property(nonatomic, copy, nullable) NSString *userPrincipal; +@property(nonatomic, strong, nullable) NSArray *annotationContents; /** - * Optional. The user profile. We user user full name(First name + Last name) - * as user profile. + * Output only. The annotation metadata includes structured content in the + * current chunk. */ -@property(nonatomic, copy, nullable) NSString *userProfile; +@property(nonatomic, strong, nullable) NSArray *annotationMetadata; -@end +/** Output only. Metadata of the current chunk. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkChunkMetadata *chunkMetadata; +/** Content is a string from a document (parsed content). */ +@property(nonatomic, copy, nullable) NSString *content; /** - * Config to store data store type configuration for workspace data + * Output only. Image Data URLs if the current chunk contains images. Data URLs + * are composed of four parts: a prefix (data:), a MIME type indicating the + * type of data, an optional base64 token if non-textual, and the data itself: + * data:, */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig : GTLRObject +@property(nonatomic, strong, nullable) NSArray *dataUrls; -/** Obfuscated Dasher customer ID. */ -@property(nonatomic, copy, nullable) NSString *dasherCustomerId; +/** + * Output only. This field is OUTPUT_ONLY. It contains derived data that are + * not in the original input document. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Chunk_DerivedStructData *derivedStructData; + +/** Metadata of the document from the current chunk. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata *documentMetadata; /** - * Optional. The super admin email address for the workspace that will be used - * for access token generation. For now we only use it for Native Google Drive - * connector data ingestion. + * Unique chunk ID of the current chunk. + * + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). */ -@property(nonatomic, copy, nullable) NSString *superAdminEmailAddress; +@property(nonatomic, copy, nullable) NSString *identifier; /** - * Optional. The super admin service account for the workspace that will be - * used for access token generation. For now we only use it for Native Google - * Drive connector data ingestion. + * The full resource name of the chunk. Format: + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. + * This field must be a UTF-8 encoded string with a length limit of 1024 + * characters. */ -@property(nonatomic, copy, nullable) NSString *superAdminServiceAccount; +@property(nonatomic, copy, nullable) NSString *name; + +/** Page span of the chunk. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkPageSpan *pageSpan; /** - * The Google Workspace data source. + * Output only. Represents the relevance score based on similarity. Higher + * score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. + * Only populated on SearchResponse. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleCalendar - * Workspace Data Store contains Calendar data (Value: "GOOGLE_CALENDAR") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleChat - * Workspace Data Store contains Chat data (Value: "GOOGLE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleDrive - * Workspace Data Store contains Drive data (Value: "GOOGLE_DRIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleGroups - * Workspace Data Store contains Groups data (Value: "GOOGLE_GROUPS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleKeep - * Workspace Data Store contains Keep data (Value: "GOOGLE_KEEP") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleMail - * Workspace Data Store contains Mail data (Value: "GOOGLE_MAIL") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GooglePeople - * Workspace Data Store contains People data (Value: "GOOGLE_PEOPLE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_GoogleSites - * Workspace Data Store contains Sites data (Value: "GOOGLE_SITES") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1betaWorkspaceConfig_Type_TypeUnspecified - * Defaults to an unspecified Workspace type. (Value: "TYPE_UNSPECIFIED") + * Uses NSNumber of doubleValue. */ -@property(nonatomic, copy, nullable) NSString *type; +@property(nonatomic, strong, nullable) NSNumber *relevanceScore; @end /** - * BigQuery source import data from. + * Output only. This field is OUTPUT_ONLY. It contains derived data that are + * not in the original input document. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigQuerySource : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Chunk_DerivedStructData : GTLRObject +@end + /** - * The schema to use when parsing the data from the source. Supported values - * for user event imports: * `user_event` (default): One UserEvent per row. - * Supported values for document imports: * `document` (default): One Document - * format per row. Each document must have a valid Document.id and one of - * Document.json_data or Document.struct_data. * `custom`: One custom data per - * row in arbitrary format that conforms to the defined Schema of the data - * store. This can only be used by the GENERIC Data Store vertical. + * The annotation metadata includes structured content in the current chunk. */ -@property(nonatomic, copy, nullable) NSString *dataSchema; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata : GTLRObject /** - * Required. The BigQuery data set to copy the data from with a length limit of - * 1,024 characters. + * Output only. Image id is provided if the structured content is based on an + * image. */ -@property(nonatomic, copy, nullable) NSString *datasetId; +@property(nonatomic, copy, nullable) NSString *imageId; + +/** Output only. The structured content information. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent *structuredContent; + +@end + /** - * Intermediate Cloud Storage directory used for the import with a length limit - * of 2,000 characters. Can be specified if one wants to have the BigQuery - * export to a specific Cloud Storage directory. + * Metadata of the current chunk. This field is only populated on + * SearchService.Search API. */ -@property(nonatomic, copy, nullable) NSString *gcsStagingDir; - -/** BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *partitionDate; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkChunkMetadata : GTLRObject /** - * The project ID or the project number that contains the BigQuery source. Has - * a length limit of 128 characters. If not specified, inherits the project ID - * from the parent request. + * The next chunks of the current chunk. The number is controlled by + * SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is + * only populated on SearchService.Search API. */ -@property(nonatomic, copy, nullable) NSString *projectId; +@property(nonatomic, strong, nullable) NSArray *nextChunks; /** - * Required. The BigQuery table to copy the data from with a length limit of - * 1,024 characters. + * The previous chunks of the current chunk. The number is controlled by + * SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is + * only populated on SearchService.Search API. */ -@property(nonatomic, copy, nullable) NSString *tableId; +@property(nonatomic, strong, nullable) NSArray *previousChunks; @end /** - * The Bigtable Options object that contains information to support the import. + * Document metadata contains the information of the document of the current + * chunk. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata : GTLRObject /** - * The mapping from family names to an object that contains column families - * level information for the given column family. If a family is not present in - * this map it will be ignored. + * The mime type of the document. + * https://www.iana.org/assignments/media-types/media-types.xhtml. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions_Families *families; +@property(nonatomic, copy, nullable) NSString *mimeType; /** - * The field name used for saving row key value in the document. The name has - * to match the pattern `a-zA-Z0-9*`. + * Data representation. The structured JSON data for the document. It should + * conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ -@property(nonatomic, copy, nullable) NSString *keyFieldName; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata_StructData *structData; -@end +/** Title of the document. */ +@property(nonatomic, copy, nullable) NSString *title; +/** Uri of the document. */ +@property(nonatomic, copy, nullable) NSString *uri; -/** - * The mapping from family names to an object that contains column families - * level information for the given column family. If a family is not present in - * this map it will be ignored. - * - * @note This class is documented as having more properties of - * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily. - * Use @c -additionalJSONKeys and @c -additionalPropertyForName: to get - * the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions_Families : GTLRObject @end /** - * The column of the Bigtable. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn : GTLRObject - -/** - * The encoding mode of the values when the type is not `STRING`. Acceptable - * encoding values are: * `TEXT`: indicates values are alphanumeric text - * strings. * `BINARY`: indicates values are encoded using `HBase - * Bytes.toBytes` family of functions. This can be overridden for a specific - * column by listing that column in `columns` and specifying an encoding for - * it. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Encoding_Binary - * Binary encoding. (Value: "BINARY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Encoding_EncodingUnspecified - * The encoding is unspecified. (Value: "ENCODING_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Encoding_Text - * Text encoding. (Value: "TEXT") + * Data representation. The structured JSON data for the document. It should + * conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *encoding; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata_StructData : GTLRObject +@end + /** - * The field name to use for this column in the document. The name has to match - * the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes - * with best effort. However, due to different naming patterns, field name - * collisions could happen, where parsing behavior is undefined. + * Page span of the chunk. */ -@property(nonatomic, copy, nullable) NSString *fieldName; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkPageSpan : GTLRObject /** - * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a - * base-64 encoded string instead. + * The end page of the chunk. * - * Contains encoded binary data; GTLRBase64 can encode/decode (probably - * web-safe format). + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *qualifier; +@property(nonatomic, strong, nullable) NSNumber *pageEnd; /** - * The type of values in this column family. The values are expected to be - * encoded using `HBase Bytes.toBytes` function when the encoding value is set - * to `BINARY`. + * The start page of the chunk. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_BigNumeric - * BigDecimal type. (Value: "BIG_NUMERIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Boolean - * Boolean type. (Value: "BOOLEAN") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Integer - * Integer type. (Value: "INTEGER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Json - * JSON type. (Value: "JSON") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_Number - * Numerical type. (Value: "NUMBER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_String - * String type. (Value: "STRING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_TypeUnspecified - * The type is unspecified. (Value: "TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn_Type_VarInteger - * Variable length integer type. (Value: "VAR_INTEGER") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *type; +@property(nonatomic, strong, nullable) NSNumber *pageStart; @end /** - * The column family of the Bigtable. + * The structured content information. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent : GTLRObject -/** - * The list of objects that contains column level information for each column. - * If a column is not present in this list it will be ignored. - */ -@property(nonatomic, strong, nullable) NSArray *columns; +/** Output only. The content of the structured content. */ +@property(nonatomic, copy, nullable) NSString *content; /** - * The encoding mode of the values when the type is not STRING. Acceptable - * encoding values are: * `TEXT`: indicates values are alphanumeric text - * strings. * `BINARY`: indicates values are encoded using `HBase - * Bytes.toBytes` family of functions. This can be overridden for a specific - * column by listing that column in `columns` and specifying an encoding for - * it. + * Output only. The structure type of the structured content. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Encoding_Binary - * Binary encoding. (Value: "BINARY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Encoding_EncodingUnspecified - * The encoding is unspecified. (Value: "ENCODING_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Encoding_Text - * Text encoding. (Value: "TEXT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_CheckboxStructure + * Checkbox structure. (Value: "CHECKBOX_STRUCTURE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_ShareholderStructure + * Shareholder structure. (Value: "SHAREHOLDER_STRUCTURE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_SignatureStructure + * Signature structure. (Value: "SIGNATURE_STRUCTURE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_StructureTypeUnspecified + * Default value. (Value: "STRUCTURE_TYPE_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *encoding; +@property(nonatomic, copy, nullable) NSString *structureType; + +@end + /** - * The field name to use for this column family in the document. The name has - * to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family - * name with best effort. However, due to different naming patterns, field name - * collisions could happen, where parsing behavior is undefined. + * Cloud SQL source import data from. */ -@property(nonatomic, copy, nullable) NSString *fieldName; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CloudSqlSource : GTLRObject /** - * The type of values in this column family. The values are expected to be - * encoded using `HBase Bytes.toBytes` function when the encoding value is set - * to `BINARY`. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_BigNumeric - * BigDecimal type. (Value: "BIG_NUMERIC") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Boolean - * Boolean type. (Value: "BOOLEAN") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Integer - * Integer type. (Value: "INTEGER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Json - * JSON type. (Value: "JSON") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_Number - * Numerical type. (Value: "NUMBER") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_String - * String type. (Value: "STRING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_TypeUnspecified - * The type is unspecified. (Value: "TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily_Type_VarInteger - * Variable length integer type. (Value: "VAR_INTEGER") + * Required. The Cloud SQL database to copy the data from with a length limit + * of 256 characters. */ -@property(nonatomic, copy, nullable) NSString *type; - -@end - +@property(nonatomic, copy, nullable) NSString *databaseId; /** - * The Cloud Bigtable source for importing data. + * Intermediate Cloud Storage directory used for the import with a length limit + * of 2,000 characters. Can be specified if one wants to have the Cloud SQL + * export to a specific Cloud Storage directory. Ensure that the Cloud SQL + * service account has the necessary Cloud Storage Admin permissions to access + * the specified Cloud Storage directory. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableSource : GTLRObject +@property(nonatomic, copy, nullable) NSString *gcsStagingDir; /** - * Required. Bigtable options that contains information needed when parsing - * data into typed structures. For example, column type annotations. + * Required. The Cloud SQL instance to copy the data from with a length limit + * of 256 characters. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BigtableOptions *bigtableOptions; +@property(nonatomic, copy, nullable) NSString *instanceId; /** - * Required. The instance ID of the Cloud Bigtable that needs to be imported. + * Option for serverless export. Enabling this option will incur additional + * cost. More info can be found + * [here](https://cloud.google.com/sql/pricing#serverless). + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *instanceId; +@property(nonatomic, strong, nullable) NSNumber *offload; /** - * The project ID that contains the Bigtable source. Has a length limit of 128 + * The project ID that contains the Cloud SQL source. Has a length limit of 128 * characters. If not specified, inherits the project ID from the parent * request. */ @property(nonatomic, copy, nullable) NSString *projectId; -/** Required. The table ID of the Cloud Bigtable that needs to be imported. */ +/** + * Required. The Cloud SQL table to copy the data from with a length limit of + * 256 characters. + */ @property(nonatomic, copy, nullable) NSString *tableId; @end /** - * Request message for GroundedGenerationService.CheckGrounding method. + * Configurations used to enable CMEK data encryption with Cloud KMS keys. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig : GTLRObject -/** Answer candidate to check. It can have a maximum length of 4096 tokens. */ -@property(nonatomic, copy, nullable) NSString *answerCandidate; +/** + * Output only. The default CmekConfig for the Customer. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isDefault; -/** List of facts for the grounding check. We support up to 200 facts. */ -@property(nonatomic, strong, nullable) NSArray *facts; +/** + * Required. KMS key resource name which will be used to encrypt resources + * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. + */ +@property(nonatomic, copy, nullable) NSString *kmsKey; -/** Configuration of the grounding check. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingSpec *groundingSpec; +/** + * Output only. KMS key version resource name which will be used to encrypt + * resources `/cryptoKeyVersions/{keyVersion}`. + */ +@property(nonatomic, copy, nullable) NSString *kmsKeyVersion; /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * Output only. The timestamp of the last key rotation. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingRequest_UserLabels *userLabels; +@property(nonatomic, strong, nullable) NSNumber *lastRotationTimestampMicros; -@end +/** + * Required. The name of the CmekConfig of the form + * `projects/{project}/locations/{location}/cmekConfig` or + * `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + */ +@property(nonatomic, copy, nullable) NSString *name; +/** + * Output only. Whether the NotebookLM Corpus is ready to be used. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmNotEnabled + * The NotebookLM is not enabled. (Value: "NOTEBOOK_LM_NOT_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmNotReady + * The NotebookLM is not ready. (Value: "NOTEBOOK_LM_NOT_READY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmReady + * The NotebookLM is ready to be used. (Value: "NOTEBOOK_LM_READY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmStateUnspecified + * The NotebookLM state is unknown. (Value: + * "NOTEBOOK_LM_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *notebooklmState; /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * Optional. Single-regional CMEKs that are required for some VAIS features. + */ +@property(nonatomic, strong, nullable) NSArray *singleRegionKeys; + +/** + * Output only. The states of the CmekConfig. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Active + * The CmekConfig can be used with DataStores. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_ActiveRotating + * The KMS key version is being rotated. (Value: "ACTIVE_ROTATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Creating + * The CmekConfig is creating. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleted + * The KMS key is soft deleted. Some cleanup policy will eventually be + * applied. (Value: "DELETED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_DeleteFailed + * The CmekConfig deletion process failed. (Value: "DELETE_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleting + * The CmekConfig is deleting. (Value: "DELETING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Expired + * The KMS key is expired, meaning the key has been disabled for 30+ + * days. The customer can call DeleteCmekConfig to change the state to + * DELETED. (Value: "EXPIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_KeyIssue + * The CmekConfig is unavailable, most likely due to the KMS Key being + * revoked. (Value: "KEY_ISSUE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_StateUnspecified + * The CmekConfig state is unknown. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Unusable + * The CmekConfig is not usable, most likely due to some internal issue. + * (Value: "UNUSABLE") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingRequest_UserLabels : GTLRObject +@property(nonatomic, copy, nullable) NSString *state; + @end /** - * Response message for the GroundedGenerationService.CheckGrounding method. + * Collection is a container for configuring resources and access to a set of + * DataStores. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Collection : GTLRObject + +/** Output only. Timestamp the Collection was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * List of facts cited across all claims in the answer candidate. These are - * derived from the facts supplied in the request. + * Required. The Collection display name. This field must be a UTF-8 encoded + * string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT + * error is returned. */ -@property(nonatomic, strong, nullable) NSArray *citedChunks; +@property(nonatomic, copy, nullable) NSString *displayName; /** - * List of facts cited across all claims in the answer candidate. These are - * derived from the facts supplied in the request. + * Immutable. The full resource name of the Collection. Format: + * `projects/{project}/locations/{location}/collections/{collection_id}`. This + * field must be a UTF-8 encoded string with a length limit of 1024 characters. */ -@property(nonatomic, strong, nullable) NSArray *citedFacts; +@property(nonatomic, copy, nullable) NSString *name; + +@end + /** - * Claim texts and citation info across all claims in the answer candidate. + * Response message for CompletionService.CompleteQuery method. */ -@property(nonatomic, strong, nullable) NSArray *claims; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompleteQueryResponse : GTLRObject /** - * The support score for the input answer candidate. Higher the score, higher - * is the fraction of claims that are supported by the provided facts. This is - * always set when a response is returned. + * Results of the matched query suggestions. The result list is ordered and the + * first result is a top suggestion. + */ +@property(nonatomic, strong, nullable) NSArray *querySuggestions; + +/** + * True if the returned suggestions are all tail suggestions. For tail matching + * to be triggered, include_tail_suggestions in the request must be true and + * there must be no suggestions that match the full query. * - * Uses NSNumber of floatValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *supportScore; +@property(nonatomic, strong, nullable) NSNumber *tailMatchTriggered; @end /** - * Fact chunk for grounding check. + * Suggestions as search queries. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion : GTLRObject -/** Text content of the fact chunk. Can be at most 10K characters long. */ -@property(nonatomic, copy, nullable) NSString *chunkText; +/** + * The unique document field paths that serve as the source of this suggestion + * if it was generated from completable fields. This field is only populated + * for the document-completable model. + */ +@property(nonatomic, strong, nullable) NSArray *completableFieldPaths; + +/** The suggestion for the query. */ +@property(nonatomic, copy, nullable) NSString *suggestion; @end /** - * Text and citation info for a claim in the answer candidate. + * Detailed completion information including completion attribution token and + * clicked completion info. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompletionInfo : GTLRObject /** - * A list of indices (into 'cited_chunks') specifying the citations associated - * with the claim. For instance [1,3,4] means that cited_chunks[1], - * cited_chunks[3], cited_chunks[4] are the facts cited supporting for the - * claim. A citation to a fact indicates that the claim is supported by the - * fact. + * End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, + * starting from 0. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSArray *citationIndices; +@property(nonatomic, strong, nullable) NSNumber *selectedPosition; + +/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */ +@property(nonatomic, copy, nullable) NSString *selectedSuggestion; + +@end + /** - * Text for the claim in the answer candidate. Always provided regardless of - * whether citations or anti-citations are found. + * Autocomplete suggestions that are imported from Customer. */ -@property(nonatomic, copy, nullable) NSString *claimText; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompletionSuggestion : GTLRObject + +/** Alternative matching phrases for this suggestion. */ +@property(nonatomic, strong, nullable) NSArray *alternativePhrases; /** - * Position indicating the end of the claim in the answer candidate, exclusive, - * in bytes. Note that this is not measured in characters and, therefore, must - * be rendered as such. For example, if the claim text contains non-ASCII - * characters, the start and end positions vary when measured in characters - * (programming-language-dependent) and when measured in bytes - * (programming-language-independent). + * Frequency of this suggestion. Will be used to rank suggestions when score is + * not available. * - * Uses NSNumber of intValue. + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSNumber *endPos; +@property(nonatomic, strong, nullable) NSNumber *frequency; /** - * Indicates that this claim required grounding check. When the system decided - * this claim doesn't require attribution/grounding check, this field will be - * set to false. In that case, no grounding check was done for the claim and - * therefore citation_indices should not be returned. + * Global score of this suggestion. Control how this suggestion would be scored + * / ranked. * - * Uses NSNumber of boolValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *groundingCheckRequired; +@property(nonatomic, strong, nullable) NSNumber *globalScore; /** - * Confidence score for the claim in the answer candidate, in the range of [0, - * 1]. This is set only when - * `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. - * - * Uses NSNumber of doubleValue. + * If two suggestions have the same groupId, they will not be returned + * together. Instead the one ranked higher will be returned. This can be used + * to deduplicate semantically identical suggestions. */ -@property(nonatomic, strong, nullable) NSNumber *score; +@property(nonatomic, copy, nullable) NSString *groupId; /** - * Position indicating the start of the claim in the answer candidate, measured - * in bytes. Note that this is not measured in characters and, therefore, must - * be rendered in the user interface keeping in mind that some characters may - * take more than one byte. For example, if the claim text contains non-ASCII - * characters, the start and end positions vary when measured in characters - * (programming-language-dependent) and when measured in bytes - * (programming-language-independent). + * The score of this suggestion within its group. * - * Uses NSNumber of intValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *startPos; +@property(nonatomic, strong, nullable) NSNumber *groupScore; + +/** BCP-47 language code of this suggestion. */ +@property(nonatomic, copy, nullable) NSString *languageCode; + +/** Required. The suggestion text. */ +@property(nonatomic, copy, nullable) NSString *suggestion; @end /** - * Specification for the grounding check. + * Defines circumstances to be checked before allowing a behavior */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CheckGroundingSpec : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Condition : GTLRObject /** - * The threshold (in [0,1]) used for determining whether a fact must be cited - * for a claim in the answer candidate. Choosing a higher threshold will lead - * to fewer but very strong citations, while choosing a lower threshold may - * lead to more but somewhat weaker citations. If unset, the threshold will - * default to 0.6. - * - * Uses NSNumber of doubleValue. + * Range of time(s) specifying when condition is active. Maximum of 10 time + * ranges. */ -@property(nonatomic, strong, nullable) NSNumber *citationThreshold; +@property(nonatomic, strong, nullable) NSArray *activeTimeRange; /** - * The control flag that enables claim-level grounding score in the response. - * - * Uses NSNumber of boolValue. + * Optional. Query regex to match the whole search query. Cannot be set when + * Condition.query_terms is set. Only supported for Basic Site Search promotion + * serving controls. */ -@property(nonatomic, strong, nullable) NSNumber *enableClaimLevelScore; +@property(nonatomic, copy, nullable) NSString *queryRegex; + +/** + * Search only A list of terms to match the query on. Cannot be set when + * Condition.query_regex is set. Maximum of 10 query terms. + */ +@property(nonatomic, strong, nullable) NSArray *queryTerms; @end /** - * Chunk captures all raw metadata information of items to be recommended or - * searched in the chunk mode. + * Matcher for search request query */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Chunk : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionQueryTerm : GTLRObject /** - * Output only. Annotation contents if the current chunk contains annotations. + * Whether the search query needs to exactly match the query term. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *annotationContents; +@property(nonatomic, strong, nullable) NSNumber *fullMatch; /** - * Output only. The annotation metadata includes structured content in the - * current chunk. + * The specific query value to match against Must be lowercase, must be UTF-8. + * Can have at most 3 space separated terms if full_match is true. Cannot be an + * empty string. Maximum length of 5000 characters. */ -@property(nonatomic, strong, nullable) NSArray *annotationMetadata; +@property(nonatomic, copy, nullable) NSString *value; -/** Output only. Metadata of the current chunk. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkChunkMetadata *chunkMetadata; +@end -/** Content is a string from a document (parsed content). */ -@property(nonatomic, copy, nullable) NSString *content; /** - * Output only. Image Data URLs if the current chunk contains images. Data URLs - * are composed of four parts: a prefix (data:), a MIME type indicating the - * type of data, an optional base64 token if non-textual, and the data itself: - * data:, + * Used for time-dependent conditions. */ -@property(nonatomic, strong, nullable) NSArray *dataUrls; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionTimeRange : GTLRObject + +/** End of time range. Range is inclusive. Must be in the future. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; + +/** Start of time range. Range is inclusive. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; + +@end + /** - * Output only. This field is OUTPUT_ONLY. It contains derived data that are - * not in the original input document. + * The contact info stored in resource level. If both project level and + * resource level is populated, the resource level contact info will override + * the project level contact info. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Chunk_DerivedStructData *derivedStructData; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ContactDetails : GTLRObject + +/** Optional. The email address of the contact. */ +@property(nonatomic, copy, nullable) NSString *emailAddress; + +@end -/** Metadata of the document from the current chunk. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata *documentMetadata; /** - * Unique chunk ID of the current chunk. - * - * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + * Defines a conditioned behavior to employ during serving. Must be attached to + * a ServingConfig to be considered at serving time. Permitted actions + * dependent on `SolutionType`. */ -@property(nonatomic, copy, nullable) NSString *identifier; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control : GTLRObject /** - * The full resource name of the chunk. Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. - * This field must be a UTF-8 encoded string with a length limit of 1024 - * characters. + * Output only. List of all ServingConfig IDs this control is attached to. May + * take up to 10 minutes to update after changes. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSArray *associatedServingConfigIds; -/** Page span of the chunk. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkPageSpan *pageSpan; +/** Defines a boost-type control */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostAction *boostAction; + +/** + * Determines when the associated action will trigger. Omit to always apply the + * action. Currently only a single condition may be specified. Otherwise an + * INVALID ARGUMENT error is thrown. + */ +@property(nonatomic, strong, nullable) NSArray *conditions; + +/** + * Required. Human readable name. The identifier used in UI views. Must be + * UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID + * ARGUMENT error is thrown. + */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** Defines a filter-type control Currently not supported by Recommendation */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlFilterAction *filterAction; /** - * Output only. Represents the relevance score based on similarity. Higher - * score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. - * Only populated on SearchResponse. - * - * Uses NSNumber of doubleValue. + * Immutable. Fully qualified name `projects/ * /locations/global/dataStore/ * + * /controls/ *` */ -@property(nonatomic, strong, nullable) NSNumber *relevanceScore; +@property(nonatomic, copy, nullable) NSString *name; -@end +/** Promote certain links based on predefined trigger queries. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlPromoteAction *promoteAction; +/** Defines a redirect-type control. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlRedirectAction *redirectAction; /** - * Output only. This field is OUTPUT_ONLY. It contains derived data that are - * not in the original input document. + * Required. Immutable. What solution the control belongs to. Must be + * compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is + * thrown. * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeChat + * Used for use cases related to the Generative AI agent. (Value: + * "SOLUTION_TYPE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeGenerativeChat + * Used for use cases related to the Generative Chat agent. It's used for + * Generative chat engine only, the associated data stores must enrolled + * with `SOLUTION_TYPE_CHAT` solution. (Value: + * "SOLUTION_TYPE_GENERATIVE_CHAT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeRecommendation + * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeSearch + * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeUnspecified + * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Chunk_DerivedStructData : GTLRObject -@end - +@property(nonatomic, copy, nullable) NSString *solutionType; -/** - * The annotation metadata includes structured content in the current chunk. - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata : GTLRObject +/** Treats a group of terms as synonyms of one another. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction *synonymsAction; /** - * Output only. Image id is provided if the structured content is based on an - * image. + * Specifies the use case for the control. Affects what condition fields can be + * set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case + * per control. Must be set when solution_type is + * SolutionType.SOLUTION_TYPE_SEARCH. */ -@property(nonatomic, copy, nullable) NSString *imageId; - -/** Output only. The structured content information. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent *structuredContent; +@property(nonatomic, strong, nullable) NSArray *useCases; @end /** - * Metadata of the current chunk. This field is only populated on - * SearchService.Search API. + * Adjusts order of products in returned list. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkChunkMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostAction : GTLRObject /** - * The next chunks of the current chunk. The number is controlled by - * SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is - * only populated on SearchService.Search API. + * Strength of the boost, which should be in [-1, 1]. Negative boost means + * demotion. Default is 0.0 (No-op). + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, strong, nullable) NSArray *nextChunks; +@property(nonatomic, strong, nullable) NSNumber *boost GTLR_DEPRECATED; /** - * The previous chunks of the current chunk. The number is controlled by - * SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is - * only populated on SearchService.Search API. + * Required. Specifies which data store's documents can be boosted by this + * control. Full data store name e.g. + * projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ -@property(nonatomic, strong, nullable) NSArray *previousChunks; - -@end - +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * Document metadata contains the information of the document of the current - * chunk. + * Required. Specifies which products to apply the boost to. If no filter is + * provided all products will be boosted (No-op). Syntax documentation: + * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 + * characters. Otherwise an INVALID ARGUMENT error is thrown. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata : GTLRObject +@property(nonatomic, copy, nullable) NSString *filter; /** - * The mime type of the document. - * https://www.iana.org/assignments/media-types/media-types.xhtml. + * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost + * means demotion. Default is 0.0 (No-op). + * + * Uses NSNumber of floatValue. */ -@property(nonatomic, copy, nullable) NSString *mimeType; +@property(nonatomic, strong, nullable) NSNumber *fixedBoost; /** - * Data representation. The structured JSON data for the document. It should - * conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * Optional. Complex specification for custom ranking based on customer defined + * attribute value. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata_StructData *structData; - -/** Title of the document. */ -@property(nonatomic, copy, nullable) NSString *title; - -/** Uri of the document. */ -@property(nonatomic, copy, nullable) NSString *uri; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec *interpolationBoostSpec; @end /** - * Data representation. The structured JSON data for the document. It should - * conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. - * - * @note This class is documented as having more properties of any valid JSON - * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to - * get the list of properties and then fetch them; or @c - * -additionalProperties to fetch them all at once. + * Specification for custom ranking based on customer specified attribute + * value. It provides more controls for customized ranking than the simple + * (condition, boost) combination above. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkDocumentMetadata_StructData : GTLRObject -@end +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec : GTLRObject +/** + * Optional. The attribute type to be used to determine the boost amount. The + * attribute value can be derived from the field value of the specified + * field_name. In the case of numerical it is straightforward i.e. + * attribute_value = numerical_field_value. In the case of freshness however, + * attribute_value = (time.now() - datetime_field_value). + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_AttributeType_AttributeTypeUnspecified + * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_AttributeType_Freshness + * For the freshness use case the attribute value will be the duration + * between the current time and the date in the datetime field specified. + * The value must be formatted as an XSD `dayTimeDuration` value (a + * restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: + * "FRESHNESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_AttributeType_Numerical + * The value of the numerical field will be used to dynamically update + * the boost amount. In this case, the attribute_value (the x value) of + * the control point will be the actual value of the numerical field for + * which the boost_amount is specified. (Value: "NUMERICAL") + */ +@property(nonatomic, copy, nullable) NSString *attributeType; /** - * Page span of the chunk. + * Optional. The control points used to define the curve. The monotonic + * function (defined through the interpolation_type above) passes through the + * control points listed here. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkPageSpan : GTLRObject +@property(nonatomic, strong, nullable) NSArray *controlPoints; /** - * The end page of the chunk. - * - * Uses NSNumber of intValue. + * Optional. The name of the field whose value will be used to determine the + * boost amount. */ -@property(nonatomic, strong, nullable) NSNumber *pageEnd; +@property(nonatomic, copy, nullable) NSString *fieldName; /** - * The start page of the chunk. + * Optional. The interpolation type to be applied to connect the control points + * listed below. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified + * Interpolation type is unspecified. In this case, it defaults to + * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_InterpolationType_Linear + * Piecewise linear interpolation will be applied. (Value: "LINEAR") */ -@property(nonatomic, strong, nullable) NSNumber *pageStart; +@property(nonatomic, copy, nullable) NSString *interpolationType; @end /** - * The structured content information. + * The control points used to define the curve. The curve defined through these + * control points can only be monotonically increasing or decreasing(constant + * values are acceptable). */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint : GTLRObject -/** Output only. The content of the structured content. */ -@property(nonatomic, copy, nullable) NSString *content; +/** + * Optional. Can be one of: 1. The numerical field value. 2. The duration spec + * for freshness: The value must be formatted as an XSD `dayTimeDuration` value + * (a restricted subset of an ISO 8601 duration value). The pattern for this + * is: `nDnM]`. + */ +@property(nonatomic, copy, nullable) NSString *attributeValue; /** - * Output only. The structure type of the structured content. + * Optional. The value between -1 to 1 by which to boost the score if the + * attribute_value evaluates to the value specified above. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_CheckboxStructure - * Checkbox structure. (Value: "CHECKBOX_STRUCTURE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_ShareholderStructure - * Shareholder structure. (Value: "SHAREHOLDER_STRUCTURE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_SignatureStructure - * Signature structure. (Value: "SIGNATURE_STRUCTURE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ChunkStructuredContent_StructureType_StructureTypeUnspecified - * Default value. (Value: "STRUCTURE_TYPE_UNSPECIFIED") + * Uses NSNumber of floatValue. */ -@property(nonatomic, copy, nullable) NSString *structureType; +@property(nonatomic, strong, nullable) NSNumber *boostAmount; @end /** - * Cloud SQL source import data from. + * Specified which products may be included in results. Uses same filter as + * boost. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CloudSqlSource : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlFilterAction : GTLRObject /** - * Required. The Cloud SQL database to copy the data from with a length limit - * of 256 characters. + * Required. Specifies which data store's documents can be filtered by this + * control. Full data store name e.g. + * projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ -@property(nonatomic, copy, nullable) NSString *databaseId; +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * Intermediate Cloud Storage directory used for the import with a length limit - * of 2,000 characters. Can be specified if one wants to have the Cloud SQL - * export to a specific Cloud Storage directory. Ensure that the Cloud SQL - * service account has the necessary Cloud Storage Admin permissions to access - * the specified Cloud Storage directory. + * Required. A filter to apply on the matching condition results. Required + * Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order + * Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is + * thrown. */ -@property(nonatomic, copy, nullable) NSString *gcsStagingDir; +@property(nonatomic, copy, nullable) NSString *filter; -/** - * Required. The Cloud SQL instance to copy the data from with a length limit - * of 256 characters. - */ -@property(nonatomic, copy, nullable) NSString *instanceId; +@end -/** - * Option for serverless export. Enabling this option will incur additional - * cost. More info can be found - * [here](https://cloud.google.com/sql/pricing#serverless). - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *offload; /** - * The project ID that contains the Cloud SQL source. Has a length limit of 128 - * characters. If not specified, inherits the project ID from the parent - * request. + * Promote certain links based on some trigger queries. Example: Promote shoe + * store link when searching for `shoe` keyword. The link can be outside of + * associated data store. */ -@property(nonatomic, copy, nullable) NSString *projectId; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlPromoteAction : GTLRObject -/** - * Required. The Cloud SQL table to copy the data from with a length limit of - * 256 characters. - */ -@property(nonatomic, copy, nullable) NSString *tableId; +/** Required. Data store with which this promotion is attached to. */ +@property(nonatomic, copy, nullable) NSString *dataStore; + +/** Required. Promotion attached to this action. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchLinkPromotion *searchLinkPromotion; @end /** - * Configurations used to enable CMEK data encryption with Cloud KMS keys. + * Redirects a shopper to the provided URI. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlRedirectAction : GTLRObject /** - * Output only. The default CmekConfig for the Customer. - * - * Uses NSNumber of boolValue. + * Required. The URI to which the shopper will be redirected. Required. URI + * must have length equal or less than 2000 characters. Otherwise an INVALID + * ARGUMENT error is thrown. */ -@property(nonatomic, strong, nullable) NSNumber *isDefault; +@property(nonatomic, copy, nullable) NSString *redirectUri; -/** - * Required. KMS key resource name which will be used to encrypt resources - * `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. - */ -@property(nonatomic, copy, nullable) NSString *kmsKey; +@end -/** - * Output only. KMS key version resource name which will be used to encrypt - * resources `/cryptoKeyVersions/{keyVersion}`. - */ -@property(nonatomic, copy, nullable) NSString *kmsKeyVersion; /** - * Output only. The timestamp of the last key rotation. - * - * Uses NSNumber of longLongValue. + * Creates a set of terms that will act as synonyms of one another. Example: + * "happy" will also be considered as "glad", "glad" will also be considered as + * "happy". */ -@property(nonatomic, strong, nullable) NSNumber *lastRotationTimestampMicros; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction : GTLRObject /** - * Required. The name of the CmekConfig of the form - * `projects/{project}/locations/{location}/cmekConfig` or - * `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at + * least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSArray *synonyms; + +@end + /** - * Output only. Whether the NotebookLM Corpus is ready to be used. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmNotEnabled - * The NotebookLM is not enabled. (Value: "NOTEBOOK_LM_NOT_ENABLED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmNotReady - * The NotebookLM is not ready. (Value: "NOTEBOOK_LM_NOT_READY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmReady - * The NotebookLM is ready to be used. (Value: "NOTEBOOK_LM_READY") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_NotebooklmState_NotebookLmStateUnspecified - * The NotebookLM state is unknown. (Value: - * "NOTEBOOK_LM_STATE_UNSPECIFIED") + * External conversation proto definition. */ -@property(nonatomic, copy, nullable) NSString *notebooklmState; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation : GTLRObject + +/** Output only. The time the conversation finished. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; + +/** Conversation messages. */ +@property(nonatomic, strong, nullable) NSArray *messages; /** - * Optional. Single-regional CMEKs that are required for some VAIS features. + * Immutable. Fully qualified name + * `projects/{project}/locations/global/collections/{collection}/dataStore/ * + * /conversations/ *` or + * `projects/{project}/locations/global/collections/{collection}/engines/ * + * /conversations/ *`. */ -@property(nonatomic, strong, nullable) NSArray *singleRegionKeys; +@property(nonatomic, copy, nullable) NSString *name; + +/** Output only. The time the conversation started. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; /** - * Output only. The states of the CmekConfig. + * The state of the Conversation. * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Active - * The CmekConfig can be used with DataStores. (Value: "ACTIVE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_ActiveRotating - * The KMS key version is being rotated. (Value: "ACTIVE_ROTATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Creating - * The CmekConfig is creating. (Value: "CREATING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleted - * The KMS key is soft deleted. Some cleanup policy will eventually be - * applied. (Value: "DELETED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_DeleteFailed - * The CmekConfig deletion process failed. (Value: "DELETE_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Deleting - * The CmekConfig is deleting. (Value: "DELETING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_KeyIssue - * The CmekConfig is unavailable, most likely due to the KMS Key being - * revoked. (Value: "KEY_ISSUE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_StateUnspecified - * The CmekConfig state is unknown. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig_State_Unusable - * The CmekConfig is not usable, most likely due to some internal issue. - * (Value: "UNUSABLE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation_State_Completed + * Conversation has been completed. (Value: "COMPLETED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation_State_InProgress + * Conversation is currently open. (Value: "IN_PROGRESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation_State_StateUnspecified + * Unknown. (Value: "STATE_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *state; +/** A unique identifier for tracking users. */ +@property(nonatomic, copy, nullable) NSString *userPseudoId; + @end /** - * Response message for CompletionService.CompleteQuery method. + * Defines context of the conversation */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompleteQueryResponse : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationContext : GTLRObject /** - * Results of the matched query suggestions. The result list is ordered and the - * first result is a top suggestion. + * The current active document the user opened. It contains the document + * resource reference. */ -@property(nonatomic, strong, nullable) NSArray *querySuggestions; +@property(nonatomic, copy, nullable) NSString *activeDocument; /** - * True if the returned suggestions are all tail suggestions. For tail matching - * to be triggered, include_tail_suggestions in the request must be true and - * there must be no suggestions that match the full query. - * - * Uses NSNumber of boolValue. + * The current list of documents the user is seeing. It contains the document + * resource references. */ -@property(nonatomic, strong, nullable) NSNumber *tailMatchTriggered; +@property(nonatomic, strong, nullable) NSArray *contextDocuments; @end /** - * Suggestions as search queries. + * Defines a conversation message. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompleteQueryResponseQuerySuggestion : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage : GTLRObject -/** - * The unique document field paths that serve as the source of this suggestion - * if it was generated from completable fields. This field is only populated - * for the document-completable model. - */ -@property(nonatomic, strong, nullable) NSArray *completableFieldPaths; +/** Output only. Message creation timestamp. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** The suggestion for the query. */ -@property(nonatomic, copy, nullable) NSString *suggestion; +/** Search reply. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Reply *reply; + +/** User text input. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TextInput *userInput; @end /** - * Detailed completion information including completion attribution token and - * clicked completion info. + * Request message for ConversationalSearchService.ConverseConversation method. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompletionInfo : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest : GTLRObject /** - * End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, - * starting from 0. - * - * Uses NSNumber of intValue. + * Boost specification to boost certain documents in search results which may + * affect the converse response. For more information on boosting, see + * [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */ -@property(nonatomic, strong, nullable) NSNumber *selectedPosition; - -/** End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */ -@property(nonatomic, copy, nullable) NSString *selectedSuggestion; - -@end +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpec *boostSpec; +/** + * The conversation to be used by auto session only. The name field will be + * ignored as we automatically assign new name for the conversation in auto + * session. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation *conversation; /** - * Autocomplete suggestions that are imported from Customer. + * The filter syntax consists of an expression language for constructing a + * predicate from one or more fields of the documents being filtered. Filter + * expression is case-sensitive. This will be used to filter search results + * which may affect the summary response. If this field is unrecognizable, an + * `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by + * mapping the LHS filter key to a key property defined in the Vertex AI Search + * backend -- this mapping is defined by the customer in their schema. For + * example a media customer might have a field 'name' in their schema. In this + * case the filter would look like this: filter --> name:'ANY("king kong")' For + * more information about filtering including syntax and filter operators, see + * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CompletionSuggestion : GTLRObject +@property(nonatomic, copy, nullable) NSString *filter; -/** Alternative matching phrases for this suggestion. */ -@property(nonatomic, strong, nullable) NSArray *alternativePhrases; +/** Required. Current user input. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TextInput *query; /** - * Frequency of this suggestion. Will be used to rank suggestions when score is - * not available. + * Whether to turn on safe search. * - * Uses NSNumber of longLongValue. + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *frequency; +@property(nonatomic, strong, nullable) NSNumber *safeSearch; /** - * Global score of this suggestion. Control how this suggestion would be scored - * / ranked. - * - * Uses NSNumber of doubleValue. + * The resource name of the Serving Config to use. Format: + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + * If this is not set, the default serving config will be used. */ -@property(nonatomic, strong, nullable) NSNumber *globalScore; +@property(nonatomic, copy, nullable) NSString *servingConfig; + +/** A specification for configuring the summary returned in the response. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec *summarySpec; /** - * If two suggestions have the same groupId, they will not be returned - * together. Instead the one ranked higher will be returned. This can be used - * to deduplicate semantically identical suggestions. + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. */ -@property(nonatomic, copy, nullable) NSString *groupId; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels *userLabels; + +@end + /** - * The score of this suggestion within its group. + * The user labels applied to a resource must meet the following requirements: + * * Each resource can have multiple labels, up to a maximum of 64. * Each + * label must be a key-value pair. * Keys have a minimum length of 1 character + * and a maximum length of 63 characters and cannot be empty. Values can be + * empty and have a maximum length of 63 characters. * Keys and values can + * contain only lowercase letters, numeric characters, underscores, and dashes. + * All characters must use UTF-8 encoding, and international characters are + * allowed. * The key portion of a label must be unique. However, you can use + * the same key with multiple resources. * Keys must start with a lowercase + * letter or international character. See [Google Cloud + * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + * for more details. * - * Uses NSNumber of doubleValue. + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *groupScore; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels : GTLRObject +@end + + +/** + * Response message for ConversationalSearchService.ConverseConversation + * method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationResponse : GTLRObject -/** BCP-47 language code of this suggestion. */ -@property(nonatomic, copy, nullable) NSString *languageCode; +/** Updated conversation including the answer. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation *conversation; -/** Required. The suggestion text. */ -@property(nonatomic, copy, nullable) NSString *suggestion; +/** Answer to the current query. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Reply *reply; -@end +/** Search Results. */ +@property(nonatomic, strong, nullable) NSArray *searchResults; +@end -/** - * Defines circumstances to be checked before allowing a behavior - */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Condition : GTLRObject /** - * Range of time(s) specifying when condition is active. Maximum of 10 time - * ranges. + * Metadata related to the progress of the DataStoreService.CreateDataStore + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@property(nonatomic, strong, nullable) NSArray *activeTimeRange; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateDataStoreMetadata : GTLRObject -/** - * Optional. Query regex to match the whole search query. Cannot be set when - * Condition.query_terms is set. Only supported for Basic Site Search promotion - * serving controls. - */ -@property(nonatomic, copy, nullable) NSString *queryRegex; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Search only A list of terms to match the query on. Cannot be set when - * Condition.query_regex is set. Maximum of 10 query terms. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSArray *queryTerms; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Matcher for search request query + * Metadata related to the progress of the EngineService.CreateEngine + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionQueryTerm : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateEngineMetadata : GTLRObject -/** - * Whether the search query needs to exactly match the query term. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *fullMatch; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * The specific query value to match against Must be lowercase, must be UTF-8. - * Can have at most 3 space separated terms if full_match is true. Cannot be an - * empty string. Maximum length of 5000 characters. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *value; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Used for time-dependent conditions. + * Metadata for Create Schema LRO. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConditionTimeRange : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSchemaMetadata : GTLRObject -/** End of time range. Range is inclusive. Must be in the future. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** Start of time range. Range is inclusive. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Defines a conditioned behavior to employ during serving. Must be attached to - * a ServingConfig to be considered at serving time. Permitted actions - * dependent on `SolutionType`. + * Metadata related to the progress of the + * SiteSearchEngineService.CreateSitemap operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSitemapMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Output only. List of all ServingConfig IDs this control is attached to. May - * take up to 10 minutes to update after changes. + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, strong, nullable) NSArray *associatedServingConfigIds; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** Defines a boost-type control */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostAction *boostAction; +@end -/** - * Determines when the associated action will trigger. Omit to always apply the - * action. Currently only a single condition may be specified. Otherwise an - * INVALID ARGUMENT error is thrown. - */ -@property(nonatomic, strong, nullable) NSArray *conditions; /** - * Required. Human readable name. The identifier used in UI views. Must be - * UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID - * ARGUMENT error is thrown. + * Metadata related to the progress of the + * SiteSearchEngineService.CreateTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata : GTLRObject -/** Defines a filter-type control Currently not supported by Recommendation */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlFilterAction *filterAction; +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Immutable. Fully qualified name `projects/ * /locations/global/dataStore/ * - * /controls/ *` + * Operation last update time. If the operation is done, this is also the + * finish time. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; -/** Promote certain links based on predefined trigger queries. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlPromoteAction *promoteAction; +@end -/** Defines a redirect-type control. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlRedirectAction *redirectAction; /** - * Required. Immutable. What solution the control belongs to. Must be - * compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is - * thrown. - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeChat - * Used for use cases related to the Generative AI agent. (Value: - * "SOLUTION_TYPE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeGenerativeChat - * Used for use cases related to the Generative Chat agent. It's used for - * Generative chat engine only, the associated data stores must enrolled - * with `SOLUTION_TYPE_CHAT` solution. (Value: - * "SOLUTION_TYPE_GENERATIVE_CHAT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeRecommendation - * Used for Recommendations AI. (Value: "SOLUTION_TYPE_RECOMMENDATION") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeSearch - * Used for Discovery Search. (Value: "SOLUTION_TYPE_SEARCH") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Control_SolutionType_SolutionTypeUnspecified - * Default value. (Value: "SOLUTION_TYPE_UNSPECIFIED") + * Request message for SiteSearchEngineService.CreateTargetSite method. */ -@property(nonatomic, copy, nullable) NSString *solutionType; - -/** Treats a group of terms as synonyms of one another. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction *synonymsAction; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteRequest : GTLRObject /** - * Specifies the use case for the control. Affects what condition fields can be - * set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case - * per control. Must be set when solution_type is - * SolutionType.SOLUTION_TYPE_SEARCH. + * Required. Parent resource name of TargetSite, such as + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. */ -@property(nonatomic, strong, nullable) NSArray *useCases; +@property(nonatomic, copy, nullable) NSString *parent; + +/** Required. The TargetSite to create. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite *targetSite; @end /** - * Adjusts order of products in returned list. + * A custom attribute that is not explicitly modeled in a resource, e.g. + * UserEvent. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostAction : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute : GTLRObject /** - * Strength of the boost, which should be in [-1, 1]. Negative boost means - * demotion. Default is 0.0 (No-op). + * The numerical values of this custom attribute. For example, `[2.3, 15.4]` + * when the key is "lengths_cm". Exactly one of CustomAttribute.text or + * CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` + * error is returned. * - * Uses NSNumber of floatValue. + * Uses NSNumber of doubleValue. */ -@property(nonatomic, strong, nullable) NSNumber *boost GTLR_DEPRECATED; +@property(nonatomic, strong, nullable) NSArray *numbers; /** - * Required. Specifies which data store's documents can be boosted by this - * control. Full data store name e.g. - * projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * The textual values of this custom attribute. For example, `["yellow", + * "green"]` when the key is "color". Empty string is not allowed. Otherwise, + * an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text + * or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` + * error is returned. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@property(nonatomic, strong, nullable) NSArray *text; -/** - * Required. Specifies which products to apply the boost to. If no filter is - * provided all products will be boosted (No-op). Syntax documentation: - * https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 - * characters. Otherwise an INVALID ARGUMENT error is thrown. - */ -@property(nonatomic, copy, nullable) NSString *filter; +@end -/** - * Optional. Strength of the boost, which should be in [-1, 1]. Negative boost - * means demotion. Default is 0.0 (No-op). - * - * Uses NSNumber of floatValue. - */ -@property(nonatomic, strong, nullable) NSNumber *fixedBoost; /** - * Optional. Complex specification for custom ranking based on customer defined - * attribute value. + * Metadata that describes a custom tuned model. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec *interpolationBoostSpec; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel : GTLRObject -@end +/** Deprecated: Timestamp the Model was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime GTLR_DEPRECATED; +/** The display name of the model. */ +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Specification for custom ranking based on customer specified attribute - * value. It provides more controls for customized ranking than the simple - * (condition, boost) combination above. + * Currently this is only populated if the model state is + * `INPUT_VALIDATION_FAILED`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec : GTLRObject +@property(nonatomic, copy, nullable) NSString *errorMessage; + +/** The metrics of the trained model. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics *metrics; /** - * Optional. The attribute type to be used to determine the boost amount. The - * attribute value can be derived from the field value of the specified - * field_name. In the case of numerical it is straightforward i.e. - * attribute_value = numerical_field_value. In the case of freshness however, - * attribute_value = (time.now() - datetime_field_value). + * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). * * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_AttributeType_AttributeTypeUnspecified - * Unspecified AttributeType. (Value: "ATTRIBUTE_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_AttributeType_Freshness - * For the freshness use case the attribute value will be the duration - * between the current time and the date in the datetime field specified. - * The value must be formatted as an XSD `dayTimeDuration` value (a - * restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`. (Value: - * "FRESHNESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_AttributeType_Numerical - * The value of the numerical field will be used to dynamically update - * the boost amount. In this case, the attribute_value (the x value) of - * the control point will be the actual value of the numerical field for - * which the boost_amount is specified. (Value: "NUMERICAL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_InputValidationFailed + * Input data validation failed. Model training didn't start. (Value: + * "INPUT_VALIDATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_ModelStateUnspecified + * Default value. (Value: "MODEL_STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_NoImprovement + * The model training finished successfully but metrics did not improve. + * (Value: "NO_IMPROVEMENT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_ReadyForServing + * The model is ready for serving. (Value: "READY_FOR_SERVING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_Training + * The model is currently training. (Value: "TRAINING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingComplete + * The model has successfully completed training. (Value: + * "TRAINING_COMPLETE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingFailed + * The model training failed. (Value: "TRAINING_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingPaused + * The model is in a paused training state. (Value: "TRAINING_PAUSED") */ -@property(nonatomic, copy, nullable) NSString *attributeType; +@property(nonatomic, copy, nullable) NSString *modelState; /** - * Optional. The control points used to define the curve. The monotonic - * function (defined through the interpolation_type above) passes through the - * control points listed here. + * The version of the model. + * + * Uses NSNumber of longLongValue. */ -@property(nonatomic, strong, nullable) NSArray *controlPoints; +@property(nonatomic, strong, nullable) NSNumber *modelVersion; /** - * Optional. The name of the field whose value will be used to determine the - * boost amount. + * Required. The fully qualified resource name of the model. Format: + * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + * Model must be an alpha-numerical string with limit of 40 characters. */ -@property(nonatomic, copy, nullable) NSString *fieldName; +@property(nonatomic, copy, nullable) NSString *name; + +/** Timestamp the model training was initiated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *trainingStartTime; + +@end + /** - * Optional. The interpolation type to be applied to connect the control points - * listed below. + * The metrics of the trained model. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_InterpolationType_InterpolationTypeUnspecified - * Interpolation type is unspecified. In this case, it defaults to - * Linear. (Value: "INTERPOLATION_TYPE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec_InterpolationType_Linear - * Piecewise linear interpolation will be applied. (Value: "LINEAR") + * @note This class is documented as having more properties of NSNumber (Uses + * NSNumber of doubleValue.). Use @c -additionalJSONKeys and @c + * -additionalPropertyForName: to get the list of properties and then + * fetch them; or @c -additionalProperties to fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *interpolationType; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics : GTLRObject @end /** - * The control points used to define the curve. The curve defined through these - * control points can only be monotonically increasing or decreasing(constant - * values are acceptable). + * Manages the connection to external data sources for all data stores grouped + * under a Collection. It's a singleton resource of Collection. The + * initialization is only supported through + * DataConnectorService.SetUpDataConnector method, which will create a new + * Collection and initialize its DataConnector. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector : GTLRObject /** - * Optional. Can be one of: 1. The numerical field value. 2. The duration spec - * for freshness: The value must be formatted as an XSD `dayTimeDuration` value - * (a restricted subset of an ISO 8601 duration value). The pattern for this - * is: `nDnM]`. + * Optional. Whether the connector will be created with an ACL config. + * Currently this field only affects Cloud Storage and BigQuery connectors. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *attributeValue; +@property(nonatomic, strong, nullable) NSNumber *aclEnabled; + +/** Optional. Action configurations to make the connector support actions. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ActionConfig *actionConfig; /** - * Optional. The value between -1 to 1 by which to boost the score if the - * attribute_value evaluates to the value specified above. + * Output only. State of the action connector. This reflects whether the action + * connector is initializing, active or has encountered errors. * - * Uses NSNumber of floatValue. + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Active + * The connector is successfully set up and awaiting next sync run. + * (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Creating + * The connector is being set up. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Failed + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can + * be deleted by [CollectionService.DeleteCollection] API. (Value: + * "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_InitializationFailed + * Connector initialization failed. Potential causes include runtime + * errors or issues in the asynchronous pipeline, preventing the request + * from reaching downstream services (except for some connector types). + * (Value: "INITIALIZATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Running + * The connector is actively syncing records from the data source. + * (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Updating + * Connector is in the process of an update. (Value: "UPDATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ActionState_Warning + * The connector has completed a sync run, but encountered non-fatal + * errors. (Value: "WARNING") */ -@property(nonatomic, strong, nullable) NSNumber *boostAmount; - -@end +@property(nonatomic, copy, nullable) NSString *actionState; +/** Optional. The connector level alert config. */ +@property(nonatomic, strong, nullable) NSArray *alertPolicyConfigs; /** - * Specified which products may be included in results. Uses same filter as - * boost. + * Optional. Indicates whether the connector is disabled for auto run. It can + * be used to pause periodical and real time sync. Update: with the + * introduction of incremental_sync_disabled, auto_run_disabled is used to + * pause/disable only full syncs + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlFilterAction : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *autoRunDisabled; + +/** Optional. The configuration for establishing a BAP connection. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1BAPConfig *bapConfig; /** - * Required. Specifies which data store's documents can be filtered by this - * control. Full data store name e.g. - * projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * Output only. User actions that must be completed before the connector can + * start syncing data. */ -@property(nonatomic, copy, nullable) NSString *dataStore; +@property(nonatomic, strong, nullable) NSArray *blockingReasons; /** - * Required. A filter to apply on the matching condition results. Required - * Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order - * Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is - * thrown. + * Optional. The modes enabled for this connector. Default state is + * CONNECTOR_MODE_UNSPECIFIED. */ -@property(nonatomic, copy, nullable) NSString *filter; - -@end - +@property(nonatomic, strong, nullable) NSArray *connectorModes; /** - * Promote certain links based on some trigger queries. Example: Promote shoe - * store link when searching for `shoe` keyword. The link can be outside of - * associated data store. + * Output only. The type of connector. Each source can only map to one type. + * For example, salesforce, confluence and jira have THIRD_PARTY connector + * type. It is not mutable once set by system. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_BigQuery + * Big query connector. (Value: "BIG_QUERY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ConnectorTypeUnspecified + * Default value. (Value: "CONNECTOR_TYPE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_Gcnv + * Google Cloud NetApp Volumes connector. (Value: "GCNV") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GcpFhir + * Data connector connects between FHIR store and VAIS datastore. (Value: + * "GCP_FHIR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_Gcs + * Google Cloud Storage connector. (Value: "GCS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleCalendar + * Google Calendar connector. (Value: "GOOGLE_CALENDAR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleDrive + * Google Drive connector. (Value: "GOOGLE_DRIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_GoogleMail + * Gmail connector. (Value: "GOOGLE_MAIL") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_NativeCloudIdentity + * Native Cloud Identity connector for people search powered by People + * API. (Value: "NATIVE_CLOUD_IDENTITY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdParty + * Third party connector to connector to third party application. (Value: + * "THIRD_PARTY") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdPartyEua + * Connector utilized for End User Authentication features. (Value: + * "THIRD_PARTY_EUA") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_ConnectorType_ThirdPartyFederated + * Federated connector, it is a third party connector that doesn't + * ingestion data, and search is powered by third party application's + * API. (Value: "THIRD_PARTY_FEDERATED") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlPromoteAction : GTLRObject - -/** Required. Data store with which this promotion is attached to. */ -@property(nonatomic, copy, nullable) NSString *dataStore; - -/** Required. Promotion attached to this action. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchLinkPromotion *searchLinkPromotion; +@property(nonatomic, copy, nullable) NSString *connectorType; -@end +/** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *createEuaSaas; +/** Output only. Timestamp the DataConnector was created at. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Redirects a shopper to the provided URI. + * Required. The name of the data source. Supported values: `salesforce`, + * `jira`, `confluence`, `bigquery`. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlRedirectAction : GTLRObject +@property(nonatomic, copy, nullable) NSString *dataSource; /** - * Required. The URI to which the shopper will be redirected. Required. URI - * must have length equal or less than 2000 characters. Otherwise an INVALID - * ARGUMENT error is thrown. + * Optional. Any target destinations used to connect to third-party services. */ -@property(nonatomic, copy, nullable) NSString *redirectUri; +@property(nonatomic, strong, nullable) NSArray *destinationConfigs; -@end +/** + * Optional. Any params and credentials used specifically for EUA connectors. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig *endUserConfig; +/** List of entities from the connected data source to ingest. */ +@property(nonatomic, strong, nullable) NSArray *entities; /** - * Creates a set of terms that will act as synonyms of one another. Example: - * "happy" will also be considered as "glad", "glad" will also be considered as - * "happy". + * Output only. The errors from initialization or from the latest connector + * run. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ControlSynonymsAction : GTLRObject +@property(nonatomic, strong, nullable) NSArray *errors; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at - * least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * Optional. Any params and credentials used specifically for hybrid connectors + * supporting FEDERATED mode. This field should only be set if the connector is + * a hybrid connector and we want to enable FEDERATED mode. */ -@property(nonatomic, strong, nullable) NSArray *synonyms; - -@end - +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig *federatedConfig; /** - * External conversation proto definition. + * Optional. If the connector is a hybrid connector, determines whether + * ingestion is enabled and appropriate resources are provisioned during + * connector creation. If the connector is not a hybrid connector, this field + * is ignored. + * + * Uses NSNumber of boolValue. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation : GTLRObject - -/** Output only. The time the conversation finished. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; +@property(nonatomic, strong, nullable) NSNumber *hybridIngestionDisabled; -/** Conversation messages. */ -@property(nonatomic, strong, nullable) NSArray *messages; +/** + * The refresh interval to sync the Access Control List information for the + * documents ingested by this connector. If not set, the access control list + * will be refreshed at the default interval of 30 minutes. The identity + * refresh interval can be at least 30 minutes and at most 7 days. + */ +@property(nonatomic, strong, nullable) GTLRDuration *identityRefreshInterval GTLR_DEPRECATED; /** - * Immutable. Fully qualified name - * `projects/{project}/locations/global/collections/{collection}/dataStore/ * - * /conversations/ *` or - * `projects/{project}/locations/global/collections/{collection}/engines/ * - * /conversations/ *`. + * The configuration for the identity data synchronization runs. This contains + * the refresh interval to sync the Access Control List information for the + * documents ingested by this connector. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityScheduleConfig *identityScheduleConfig; -/** Output only. The time the conversation started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; +/** + * Optional. The refresh interval specifically for incremental data syncs. If + * unset, incremental syncs will use the default from env, set to 3hrs. The + * minimum is 30 minutes and maximum is 7 days. Applicable to only 3P + * connectors. When the refresh interval is set to the same value as the + * incremental refresh interval, incremental sync will be disabled. + */ +@property(nonatomic, strong, nullable) GTLRDuration *incrementalRefreshInterval; /** - * The state of the Conversation. + * Optional. Indicates whether incremental syncs are paused for this connector. + * This is independent of auto_run_disabled. Applicable to only 3P connectors. + * When the refresh interval is set to the same value as the incremental + * refresh interval, incremental sync will be disabled, i.e. set to true. * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation_State_Completed - * Conversation has been completed. (Value: "COMPLETED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation_State_InProgress - * Conversation is currently open. (Value: "IN_PROGRESS") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation_State_StateUnspecified - * Unknown. (Value: "STATE_UNSPECIFIED") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *state; - -/** A unique identifier for tracking users. */ -@property(nonatomic, copy, nullable) NSString *userPseudoId; +@property(nonatomic, strong, nullable) NSNumber *incrementalSyncDisabled; -@end +/** Required data connector parameters in json string format. */ +@property(nonatomic, copy, nullable) NSString *jsonParams; +/** + * Input only. The KMS key to be used to protect the DataStores managed by this + * connector. Must be set for requests that need to comply with CMEK Org Policy + * protections. If this field is set and processed successfully, the DataStores + * created by this connector will be protected by the KMS key. + */ +@property(nonatomic, copy, nullable) NSString *kmsKeyName; /** - * Defines context of the conversation + * Output only. For periodic connectors only, the last time a data sync was + * completed. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationContext : GTLRObject +@property(nonatomic, strong, nullable) GTLRDateTime *lastSyncTime; /** - * The current active document the user opened. It contains the document - * resource reference. + * Output only. The most recent timestamp when this DataConnector was paused, + * affecting all functionalities such as data synchronization. Pausing a + * connector has the following effects: - All functionalities, including data + * synchronization, are halted. - Any ongoing data synchronization job will be + * canceled. - No future data synchronization runs will be scheduled nor can be + * triggered. */ -@property(nonatomic, copy, nullable) NSString *activeDocument; +@property(nonatomic, strong, nullable) GTLRDateTime *latestPauseTime; /** - * The current list of documents the user is seeing. It contains the document - * resource references. + * Output only. The full resource name of the Data Connector. Format: + * `projects/ * /locations/ * /collections/ * /dataConnector`. */ -@property(nonatomic, strong, nullable) NSArray *contextDocuments; - -@end - +@property(nonatomic, copy, nullable) NSString *name; /** - * Defines a conversation message. + * Defines the scheduled time for the next data synchronization. This field + * requires hour , minute, and time_zone from the [IANA Time Zone + * Database](https://www.iana.org/time-zones). This is utilized when the data + * connector has a refresh interval greater than 1 day. When the hours or + * minutes are not specified, we will assume a sync time of 0:00. The user must + * provide a time zone to avoid ambiguity. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConversationMessage : GTLRObject - -/** Output only. Message creation timestamp. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** Search reply. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Reply *reply; - -/** User text input. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TextInput *userInput; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDateTime *nextSyncTime; -@end +/** Required data connector parameters in structured json format. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_Params *params; +/** + * Output only. The tenant project ID associated with private connectivity + * connectors. This project must be allowlisted by in order for the connector + * to function. + */ +@property(nonatomic, copy, nullable) NSString *privateConnectivityProjectId; /** - * Request message for ConversationalSearchService.ConverseConversation method. + * Output only. real-time sync state + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Active + * The connector is successfully set up and awaiting next sync run. + * (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Creating + * The connector is being set up. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Failed + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can + * be deleted by [CollectionService.DeleteCollection] API. (Value: + * "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_InitializationFailed + * Connector initialization failed. Potential causes include runtime + * errors or issues in the asynchronous pipeline, preventing the request + * from reaching downstream services (except for some connector types). + * (Value: "INITIALIZATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Running + * The connector is actively syncing records from the data source. + * (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Updating + * Connector is in the process of an update. (Value: "UPDATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_RealtimeState_Warning + * The connector has completed a sync run, but encountered non-fatal + * errors. (Value: "WARNING") */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest : GTLRObject +@property(nonatomic, copy, nullable) NSString *realtimeState; + +/** Optional. The configuration for realtime sync. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig *realtimeSyncConfig; /** - * Boost specification to boost certain documents in search results which may - * affect the converse response. For more information on boosting, see - * [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + * Required. The refresh interval for data sync. If duration is set to 0, the + * data will be synced in real time. The streaming feature is not supported + * yet. The minimum is 30 minutes and maximum is 7 days. When the refresh + * interval is set to the same value as the incremental refresh interval, + * incremental sync will be disabled. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestBoostSpec *boostSpec; +@property(nonatomic, strong, nullable) GTLRDuration *refreshInterval; /** - * The conversation to be used by auto session only. The name field will be - * ignored as we automatically assign new name for the conversation in auto - * session. + * Optional. Specifies keys to be removed from the 'params' field. This is only + * active when 'params' is included in the 'update_mask' in an + * UpdateDataConnectorRequest. Deletion takes precedence if a key is both in + * 'remove_param_keys' and present in the 'params' field of the request. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation *conversation; +@property(nonatomic, strong, nullable) NSArray *removeParamKeys; /** - * The filter syntax consists of an expression language for constructing a - * predicate from one or more fields of the documents being filtered. Filter - * expression is case-sensitive. This will be used to filter search results - * which may affect the summary response. If this field is unrecognizable, an - * `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by - * mapping the LHS filter key to a key property defined in the Vertex AI Search - * backend -- this mapping is defined by the customer in their schema. For - * example a media customer might have a field 'name' in their schema. In this - * case the filter would look like this: filter --> name:'ANY("king kong")' For - * more information about filtering including syntax and filter operators, see - * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * Output only. State of the connector. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Active + * The connector is successfully set up and awaiting next sync run. + * (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Creating + * The connector is being set up. (Value: "CREATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Failed + * The connector is in error. The error details can be found in + * DataConnector.errors. If the error is unfixable, the DataConnector can + * be deleted by [CollectionService.DeleteCollection] API. (Value: + * "FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_InitializationFailed + * Connector initialization failed. Potential causes include runtime + * errors or issues in the asynchronous pipeline, preventing the request + * from reaching downstream services (except for some connector types). + * (Value: "INITIALIZATION_FAILED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Running + * The connector is actively syncing records from the data source. + * (Value: "RUNNING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_StateUnspecified + * Default value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Updating + * Connector is in the process of an update. (Value: "UPDATING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_State_Warning + * The connector has completed a sync run, but encountered non-fatal + * errors. (Value: "WARNING") */ -@property(nonatomic, copy, nullable) NSString *filter; +@property(nonatomic, copy, nullable) NSString *state; -/** Required. Current user input. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TextInput *query; +/** Output only. The static IP addresses used by this connector. */ +@property(nonatomic, strong, nullable) NSArray *staticIpAddresses; /** - * Whether to turn on safe search. + * Optional. Whether customer has enabled static IP addresses for this + * connector. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *safeSearch; +@property(nonatomic, strong, nullable) NSNumber *staticIpEnabled; /** - * The resource name of the Serving Config to use. Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` - * If this is not set, the default serving config will be used. + * The data synchronization mode supported by the data connector. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Periodic + * The connector will sync data periodically based on the + * refresh_interval. Use it with auto_run_disabled to pause the periodic + * sync, or indicate a one-time sync. (Value: "PERIODIC") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Streaming + * The data will be synced in real time. (Value: "STREAMING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_SyncMode_Unspecified + * Connector that doesn't ingest data will have this value (Value: + * "UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *servingConfig; - -/** A specification for configuring the summary returned in the response. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec *summarySpec; +@property(nonatomic, copy, nullable) NSString *syncMode; -/** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. - */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels *userLabels; +/** Output only. Timestamp the DataConnector was last updated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * The user labels applied to a resource must meet the following requirements: - * * Each resource can have multiple labels, up to a maximum of 64. * Each - * label must be a key-value pair. * Keys have a minimum length of 1 character - * and a maximum length of 63 characters and cannot be empty. Values can be - * empty and have a maximum length of 63 characters. * Keys and values can - * contain only lowercase letters, numeric characters, underscores, and dashes. - * All characters must use UTF-8 encoding, and international characters are - * allowed. * The key portion of a label must be unique. However, you can use - * the same key with multiple resources. * Keys must start with a lowercase - * letter or international character. See [Google Cloud - * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) - * for more details. + * Required data connector parameters in structured json format. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationRequest_UserLabels : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector_Params : GTLRObject @end /** - * Response message for ConversationalSearchService.ConverseConversation - * method. + * Any params and credentials used specifically for EUA connectors. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ConverseConversationResponse : GTLRObject - -/** Updated conversation including the answer. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Conversation *conversation; +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig : GTLRObject -/** Answer to the current query. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Reply *reply; - -/** Search Results. */ -@property(nonatomic, strong, nullable) NSArray *searchResults; - -@end +/** Optional. Any additional parameters needed for EUA. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AdditionalParams *additionalParams; +/** Optional. Any authentication parameters specific to EUA connectors. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AuthParams *authParams; /** - * Metadata related to the progress of the DataStoreService.CreateDataStore - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Optional. Any authentication parameters specific to EUA connectors in json + * string format. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateDataStoreMetadata : GTLRObject - -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, copy, nullable) NSString *jsonAuthParams; -/** - * Operation last update time. If the operation is done, this is also the - * finish time. - */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +/** Optional. The tenant project the connector is connected to. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Tenant *tenant; @end /** - * Metadata related to the progress of the EngineService.CreateEngine - * operation. This will be returned by the - * google.longrunning.Operation.metadata field. + * Optional. Any additional parameters needed for EUA. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateEngineMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AdditionalParams : GTLRObject +@end -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Any authentication parameters specific to EUA connectors. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig_AuthParams : GTLRObject @end /** - * Metadata for Create Schema LRO. + * Any params and credentials used specifically for hybrid connectors + * supporting FEDERATED mode. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSchemaMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. Any additional parameters needed for FEDERATED. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AdditionalParams *additionalParams; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Any authentication parameters specific to FEDERATED connectors. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AuthParams *authParams; + +/** + * Optional. Any authentication parameters specific to FEDERATED connectors in + * json string format. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *jsonAuthParams; @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.CreateSitemap operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Optional. Any additional parameters needed for FEDERATED. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateSitemapMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AdditionalParams : GTLRObject +@end -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Any authentication parameters specific to FEDERATED connectors. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig_AuthParams : GTLRObject @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.CreateTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * The configuration for realtime sync to store additional params for realtime + * sync. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. The ID of the Secret Manager secret used for webhook secret. */ +@property(nonatomic, copy, nullable) NSString *realtimeSyncSecret; + +/** Optional. Streaming error details. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError *streamingError; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Webhook url for the connector to specify additional params for + * realtime sync. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, copy, nullable) NSString *webhookUri; @end /** - * Request message for SiteSearchEngineService.CreateTargetSite method. + * Streaming error details. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CreateTargetSiteRequest : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError : GTLRObject + +/** Optional. Error details. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleRpcStatus *error; /** - * Required. Parent resource name of TargetSite, such as - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. + * Optional. Streaming error. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_IngressEndpointRequired + * Ingress endpoint is required when setting up realtime sync in private + * connectivity. (Value: "INGRESS_ENDPOINT_REQUIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingErrorReasonUnspecified + * Streaming error reason unspecified. (Value: + * "STREAMING_ERROR_REASON_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSetupError + * Some error occurred while setting up resources for realtime sync. + * (Value: "STREAMING_SETUP_ERROR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError_StreamingErrorReason_StreamingSyncError + * Some error was encountered while running realtime sync for the + * connector. (Value: "STREAMING_SYNC_ERROR") */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** Required. The TargetSite to create. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1TargetSite *targetSite; +@property(nonatomic, copy, nullable) NSString *streamingErrorReason; @end /** - * A custom attribute that is not explicitly modeled in a resource, e.g. - * UserEvent. + * Represents an entity in the data source. For example, the `Account` object + * in Salesforce. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomAttribute : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity : GTLRObject /** - * The numerical values of this custom attribute. For example, `[2.3, 15.4]` - * when the key is "lengths_cm". Exactly one of CustomAttribute.text or - * CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` - * error is returned. - * - * Uses NSNumber of doubleValue. + * Output only. The full resource name of the associated data store for the + * source entity. Format: `projects/ * /locations/ * /collections/ * + * /dataStores/ *`. When the connector is initialized by the + * DataConnectorService.SetUpDataConnector method, a DataStore is automatically + * created for each source entity. */ -@property(nonatomic, strong, nullable) NSArray *numbers; +@property(nonatomic, copy, nullable) NSString *dataStore; /** - * The textual values of this custom attribute. For example, `["yellow", - * "green"]` when the key is "color". Empty string is not allowed. Otherwise, - * an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text - * or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` - * error is returned. + * The name of the entity. Supported values by data source: * Salesforce: + * `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` + * * Jira: `Issue` * Confluence: `Content`, `Space` + * + * Remapped to 'entityNameProperty' to avoid NSObject's 'entityName'. */ -@property(nonatomic, strong, nullable) NSArray *text; - -@end +@property(nonatomic, copy, nullable) NSString *entityNameProperty; +/** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1HealthcareFhirConfig *healthcareFhirConfig; /** - * Metadata that describes a custom tuned model. + * The parameters for the entity to facilitate data ingestion in json string + * format. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel : GTLRObject - -/** Deprecated: Timestamp the Model was created at. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime GTLR_DEPRECATED; - -/** The display name of the model. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@property(nonatomic, copy, nullable) NSString *jsonParams; /** - * Currently this is only populated if the model state is - * `INPUT_VALIDATION_FAILED`. + * Attributes for indexing. Key: Field name. Value: The key property to map a + * field to, such as `title`, and `description`. Supported key properties: * + * `title`: The title for data record. This would be displayed on search + * results. * `description`: The description for data record. This would be + * displayed on search results. */ -@property(nonatomic, copy, nullable) NSString *errorMessage; - -/** The metrics of the trained model. */ -@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics *metrics; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_KeyPropertyMappings *keyPropertyMappings; /** - * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). - * - * Likely values: - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_InputValidationFailed - * Input data validation failed. Model training didn't start. (Value: - * "INPUT_VALIDATION_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_ModelStateUnspecified - * Default value. (Value: "MODEL_STATE_UNSPECIFIED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_NoImprovement - * The model training finished successfully but metrics did not improve. - * (Value: "NO_IMPROVEMENT") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_ReadyForServing - * The model is ready for serving. (Value: "READY_FOR_SERVING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_Training - * The model is currently training. (Value: "TRAINING") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingComplete - * The model has successfully completed training. (Value: - * "TRAINING_COMPLETE") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingFailed - * The model training failed. (Value: "TRAINING_FAILED") - * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_ModelState_TrainingPaused - * The model is in a paused training state. (Value: "TRAINING_PAUSED") + * The parameters for the entity to facilitate data ingestion in structured + * json format. */ -@property(nonatomic, copy, nullable) NSString *modelState; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_Params *params; /** - * The version of the model. - * - * Uses NSNumber of longLongValue. + * Optional. The start schema to use for the DataStore created from this + * SourceEntity. If unset, a default vertical specialized schema will be used. + * This field is only used by SetUpDataConnector API, and will be ignored if + * used in other APIs. This field will be omitted from all API responses + * including GetDataConnector API. To retrieve a schema of a DataStore, use + * SchemaService.GetSchema API instead. The provided schema will be validated + * against certain rules on schema. Learn more from [this + * doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ -@property(nonatomic, strong, nullable) NSNumber *modelVersion; +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Schema *startingSchema; -/** - * Required. The fully qualified resource name of the model. Format: - * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. - * Model must be an alpha-numerical string with limit of 40 characters. - */ -@property(nonatomic, copy, nullable) NSString *name; +@end -/** Timestamp the model training was initiated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *trainingStartTime; +/** + * Attributes for indexing. Key: Field name. Value: The key property to map a + * field to, such as `title`, and `description`. Supported key properties: * + * `title`: The title for data record. This would be displayed on search + * results. * `description`: The description for data record. This would be + * displayed on search results. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_KeyPropertyMappings : GTLRObject @end /** - * The metrics of the trained model. + * The parameters for the entity to facilitate data ingestion in structured + * json format. * - * @note This class is documented as having more properties of NSNumber (Uses - * NSNumber of doubleValue.). Use @c -additionalJSONKeys and @c - * -additionalPropertyForName: to get the list of properties and then - * fetch them; or @c -additionalProperties to fetch them all at once. + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CustomTuningModel_Metrics : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnectorSourceEntity_Params : GTLRObject @end @@ -24228,6 +27365,22 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** Output only. CMEK-related information for the DataStore. */ @property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1CmekConfig *cmekConfig; +/** + * Optional. Configuration for configurable billing approach. See + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified + * Default value. For Spark and non-Spark non-configurable billing + * approach. (Value: "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableConsumptionEmbedding + * Use the consumption pay-as-you-go billing for embedding storage + * add-on. (Value: "CONFIGURABLE_CONSUMPTION_EMBEDDING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataStore_ConfigurableBillingApproach_ConfigurableSubscriptionIndexingCore + * Use the subscription base + overage billing for indexing core for non + * embedding storage. (Value: "CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE") + */ +@property(nonatomic, copy, nullable) NSString *configurableBillingApproach; + /** * Immutable. The content config of the data store. If this field is unset, the * server behavior defaults to ContentConfig.NO_CONTENT. @@ -24425,6 +27578,25 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * Metadata related to the progress of the CollectionService.UpdateCollection + * operation. This will be returned by the + * google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteCollectionMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + /** * Metadata related to the progress of the DataStoreService.DeleteDataStore * operation. This will be returned by the @@ -24510,29 +27682,87 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Metadata related to the progress of the + * SiteSearchEngineService.DeleteTargetSite operation. This will be returned by + * the google.longrunning.Operation.metadata field. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata : GTLRObject + +/** Operation create time. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Operation last update time. If the operation is done, this is also the + * finish time. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Defines target endpoints used to connect to third-party sources. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig : GTLRObject + +/** Optional. The destinations for the corresponding key. */ +@property(nonatomic, strong, nullable) NSArray *destinations; + +/** + * Additional parameters for this destination config in json string format. + */ +@property(nonatomic, copy, nullable) NSString *jsonParams; + +/** + * Optional. Unique destination identifier that is supported by the connector. + */ +@property(nonatomic, copy, nullable) NSString *key; + +/** + * Optional. Additional parameters for this destination config in structured + * json format. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig_Params *params; + +@end + + +/** + * Optional. Additional parameters for this destination config in structured + * json format. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfig_Params : GTLRObject @end /** - * Metadata related to the progress of the - * SiteSearchEngineService.DeleteTargetSite operation. This will be returned by - * the google.longrunning.Operation.metadata field. + * Defines a target endpoint */ -@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata : GTLRObject +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DestinationConfigDestination : GTLRObject -/** Operation create time. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Publicly routable host. */ +@property(nonatomic, copy, nullable) NSString *host; /** - * Operation last update time. If the operation is done, this is also the - * finish time. + * Optional. Target port number accepted by the destination. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; +@property(nonatomic, strong, nullable) NSNumber *port; @end @@ -25121,6 +28351,20 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** Common config spec that specifies the metadata of the engine. */ @property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1EngineCommonConfig *commonConfig; +/** + * Optional. Configuration for configurable billing approach. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_ConfigurableBillingApproach_ConfigurableBillingApproachEnabled + * The billing approach follows configurations specified by customer. + * (Value: "CONFIGURABLE_BILLING_APPROACH_ENABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_ConfigurableBillingApproach_ConfigurableBillingApproachUnspecified + * Default value. For Spark and non-Spark non-configurable billing + * approach. General pricing model. (Value: + * "CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *configurableBillingApproach; + /** Output only. Timestamp the Recommendation Engine was created at. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; @@ -25154,8 +28398,10 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * * `people-search-org-chart` * `bi-directional-audio` * `feedback` * - * `session-sharing` * `personalization-memory` - Enables personalization based - * on user preferences. + * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * + * `disable-image-generation` * `disable-video-generation` * + * `disable-onedrive-upload` * `disable-talk-to-content` * + * `disable-google-drive-upload` */ @property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Engine_Features *features; @@ -25233,8 +28479,10 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe * state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * * `people-search-org-chart` * `bi-directional-audio` * `feedback` * - * `session-sharing` * `personalization-memory` - Enables personalization based - * on user preferences. + * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * + * `disable-image-generation` * `disable-video-generation` * + * `disable-onedrive-upload` * `disable-talk-to-content` * + * `disable-google-drive-upload` * * @note This class is documented as having more properties of NSString. Use @c * -additionalJSONKeys and @c -additionalPropertyForName: to get the list @@ -25876,6 +29124,30 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * The configuration for the identity data synchronization runs. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1IdentityScheduleConfig : GTLRObject + +/** + * Optional. The UTC time when the next data sync is expected to start for the + * Data Connector. Customers are only able to specify the hour and minute to + * schedule the data sync. This is utilized when the data connector has a + * refresh interval greater than 1 day. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDateTime *nextSyncTime; + +/** + * Optional. The refresh interval to sync the Access Control List information + * for the documents ingested by this connector. If not set, the access control + * list will be refreshed at the default interval of 30 minutes. The identity + * refresh interval can be at least 30 minutes and at most 7 days. + */ +@property(nonatomic, strong, nullable) GTLRDuration *refreshInterval; + +@end + + /** * Identity Provider Config. */ @@ -26439,6 +29711,122 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * Information about users' licenses. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig : GTLRObject + +/** Optional. The alert policy config for this license config. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AlertPolicyResourceConfig *alertPolicyResourceConfig; + +/** + * Optional. Whether the license config should be auto renewed when it reaches + * the end date. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *autoRenew; + +/** Optional. The planed end date. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *endDate; + +/** + * Optional. Whether the license config is for free trial. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *freeTrial; + +/** + * Required. Number of licenses purchased. + * + * Uses NSNumber of longLongValue. + */ +@property(nonatomic, strong, nullable) NSNumber *licenseCount; + +/** + * Immutable. Identifier. The fully qualified resource name of the license + * config. Format: + * `projects/{project}/locations/{location}/licenseConfigs/{license_config}` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Required. The start date. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleTypeDate *startDate; + +/** + * Output only. The state of the license config. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_Active + * The license config is effective and being used. (Value: "ACTIVE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_Expired + * The license config has expired. (Value: "EXPIRED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_NotStarted + * The license config has not started yet, and its start date is in the + * future. (Value: "NOT_STARTED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_State_StateUnspecified + * Default value. The license config does not exist. (Value: + * "STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** + * Required. Subscription term. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermOneMonth + * 1 month. (Value: "SUBSCRIPTION_TERM_ONE_MONTH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermOneYear + * 1 year. (Value: "SUBSCRIPTION_TERM_ONE_YEAR") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermThreeYears + * 3 years. (Value: "SUBSCRIPTION_TERM_THREE_YEARS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTerm_SubscriptionTermUnspecified + * Default value, do not use. (Value: "SUBSCRIPTION_TERM_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *subscriptionTerm; + +/** + * Required. Subscription tier information for the license config. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceBusiness + * Agentspace Business tier. (Value: + * "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierAgentspaceStarter + * Agentspace Starter tier. (Value: + * "SUBSCRIPTION_TIER_AGENTSPACE_STARTER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEdu + * EDU tier. (Value: "SUBSCRIPTION_TIER_EDU") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduEmerging + * EDU emerging market tier. (Value: "SUBSCRIPTION_TIER_EDU_EMERGING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduPro + * EDU Pro tier. (Value: "SUBSCRIPTION_TIER_EDU_PRO") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEduProEmerging + * EDU Pro emerging market tier. (Value: + * "SUBSCRIPTION_TIER_EDU_PRO_EMERGING") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierEnterprise + * Enterprise tier. (Value: "SUBSCRIPTION_TIER_ENTERPRISE") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierFrontlineWorker + * Frontline worker tier. (Value: "SUBSCRIPTION_TIER_FRONTLINE_WORKER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierNotebookLm + * NotebookLM tier. NotebookLM is a subscription tier can only access + * NotebookLM features. (Value: "SUBSCRIPTION_TIER_NOTEBOOK_LM") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierSearch + * Search tier. Search tier can access VAIS search features and + * NotebookLM features. (Value: "SUBSCRIPTION_TIER_SEARCH") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierSearchAndAssistant + * Search + assistant tier. Search + assistant tier can access VAIS + * search features, NotebookLM features and assistant features. (Value: + * "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig_SubscriptionTier_SubscriptionTierUnspecified + * Default value. (Value: "SUBSCRIPTION_TIER_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *subscriptionTier; + +@end + + /** * Response message for CmekConfigService.ListCmekConfigs method. */ @@ -26897,6 +30285,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe /** Output only. The timestamp when this project is created. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; +/** Optional. Customer provided configurations. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig *customerProvidedConfig; + /** * Output only. Full resource name of the project, for example * `projects/{project}`. Note that when making requests, project number and @@ -26935,6 +30326,56 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * Customer provided configurations. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig : GTLRObject + +/** Optional. Configuration for NotebookLM settings. */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig *notebooklmConfig; + +@end + + +/** + * Configuration for NotebookLM. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig : GTLRObject + +/** + * Model Armor configuration to be used for sanitizing user prompts and LLM + * responses. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig *modelArmorConfig; + +@end + + +/** + * Configuration for customer defined Model Armor templates to be used for + * sanitizing user prompts and LLM responses. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig : GTLRObject + +/** + * Optional. The resource name of the Model Armor Template for sanitizing LLM + * responses. Format: + * projects/{project}/locations/{location}/templates/{template_id} If not + * specified, no sanitization will be applied to the LLM response. + */ +@property(nonatomic, copy, nullable) NSString *responseTemplate; + +/** + * Optional. The resource name of the Model Armor Template for sanitizing user + * prompts. Format: + * projects/{project}/locations/{location}/templates/{template_id} If not + * specified, no sanitization will be applied to the user prompt. + */ +@property(nonatomic, copy, nullable) NSString *userPromptTemplate; + +@end + + /** * Metadata about the terms of service. */ @@ -27036,6 +30477,14 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe */ @property(nonatomic, strong, nullable) NSNumber *acceptBizQos; +/** + * Optional. Indicates if the current request is for Biz edition (= true) or + * not (= false). + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isBiz; + @end @@ -28009,11 +31458,21 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe */ @property(nonatomic, copy, nullable) NSString *languageCode; +/** + * Optional. Config for natural language query understanding capabilities, such + * as extracting structured field filters from the query. Refer to [this + * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) + * for more information. If `naturalLanguageQueryUnderstandingSpec` is not + * specified, no additional natural language query understanding will be done. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec *naturalLanguageQueryUnderstandingSpec; + /** * A 0-indexed integer that specifies the current offset (that is, starting * result location, amongst the Documents deemed by the API as relevant) in * search results. This field is only considered if page_token is unset. If - * this field is negative, an `INVALID_ARGUMENT` is returned. + * this field is negative, an `INVALID_ARGUMENT` is returned. A large offset + * may be capped to a reasonable threshold. * * Uses NSNumber of intValue. */ @@ -28986,6 +32445,77 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * Specification to enable natural language understanding capabilities for + * search requests. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec : GTLRObject + +/** + * Optional. Allowlist of fields that can be used for natural language filter + * extraction. By default, if this is unspecified, all indexable fields are + * eligible for natural language filter extraction (but are not guaranteed to + * be used). If any fields are specified in allowed_field_names, only the + * fields that are both marked as indexable in the schema and specified in the + * allowlist will be eligible for natural language filter extraction. Note: for + * multi-datastore search, this is not yet supported, and will be ignored. + */ +@property(nonatomic, strong, nullable) NSArray *allowedFieldNames; + +/** + * Optional. Controls behavior of how extracted filters are applied to the + * search. The default behavior depends on the request. For single datastore + * structured search, the default is `HARD_FILTER`. For multi-datastore search, + * the default behavior is `SOFT_BOOST`. Location-based filters are always + * applied as hard filters, and the `SOFT_BOOST` setting will not affect them. + * This field is only used if + * SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition + * is set to FilterExtractionCondition.ENABLED. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_ExtractedFilterBehaviorUnspecified + * `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior + * for extracted filters. For single datastore search, the default is to + * apply as hard filters. For multi-datastore search, the default is to + * apply as soft boosts. (Value: "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_HardFilter + * Applies all extracted filters as hard filters on the results. Results + * that do not pass the extracted filters will not be returned in the + * result set. (Value: "HARD_FILTER") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_ExtractedFilterBehavior_SoftBoost + * Applies all extracted filters as soft boosts. Results that pass the + * filters will be boosted up to higher ranks in the result set. (Value: + * "SOFT_BOOST") + */ +@property(nonatomic, copy, nullable) NSString *extractedFilterBehavior; + +/** + * The condition under which filter extraction should occur. Server behavior + * defaults to `DISABLED`. + * + * Likely values: + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_ConditionUnspecified + * Server behavior defaults to `DISABLED`. (Value: + * "CONDITION_UNSPECIFIED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Disabled + * Disables NL filter extraction. (Value: "DISABLED") + * @arg @c kGTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec_FilterExtractionCondition_Enabled + * Enables NL filter extraction. (Value: "ENABLED") + */ +@property(nonatomic, copy, nullable) NSString *filterExtractionCondition; + +/** + * Field names used for location-based filtering, where geolocation filters are + * detected in natural language search queries. Only valid when the + * FilterExtractionCondition is set to `ENABLED`. If this field is set, it + * overrides the field names set in + * ServingConfig.geo_search_query_detection_field_names. + */ +@property(nonatomic, strong, nullable) NSArray *geoSearchQueryDetectionFieldNames; + +@end + + /** * Specification to determine under which conditions query expansion should * occur. @@ -29884,6 +33414,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe */ @property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Answer *detailedAnswer; +/** + * Output only. In ConversationalSearchService.GetSession API, if + * GetSessionRequest.include_answer_details is set to true, this field will be + * populated when getting assistant session. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1AssistAnswer *detailedAssistAnswer; + /** * Optional. The user query. May not be set if this turn is merely regenerating * an answer to a different turn @@ -29914,6 +33451,44 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * Metadata for DataConnectorService.SetUpDataConnector method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata : GTLRObject +@end + + +/** + * Request for DataConnectorService.SetUpDataConnector method. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest : GTLRObject + +/** + * Required. The display name of the Collection. Should be human readable, used + * to display collections in the Console Dashboard. UTF-8 encoded string with + * limit of 1024 characters. + */ +@property(nonatomic, copy, nullable) NSString *collectionDisplayName; + +/** + * Required. The ID to use for the Collection, which will become the final + * component of the Collection's resource name. A new Collection is created as + * part of the DataConnector setup. DataConnector is a singleton resource under + * Collection, managing all DataStores of the Collection. This field must + * conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a + * length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is + * returned. + */ +@property(nonatomic, copy, nullable) NSString *collectionId; + +/** + * Required. The DataConnector to initialize in the newly created Collection. + */ +@property(nonatomic, strong, nullable) GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector *dataConnector; + +@end + + /** * Metadata for single-regional CMEKs. */ @@ -30348,6 +33923,34 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe @end +/** + * Tenant information for a connector source. This includes some of the same + * information stored in the Credential message, but is limited to only what is + * needed to provide a list of accessible tenants to the user. + */ +@interface GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1Tenant : GTLRObject + +/** Optional display name for the tenant, e.g. "My Slack Team". */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** + * The tenant's instance ID. Examples: Jira + * ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). + * + * identifier property maps to 'id' in JSON (to avoid Objective C's 'id'). + */ +@property(nonatomic, copy, nullable) NSString *identifier; + +/** + * The URI of the tenant, if applicable. For example, the URI of a Jira + * instance is https://my-jira-instance.atlassian.net, and a Slack tenant does + * not have a URI. + */ +@property(nonatomic, copy, nullable) NSString *uri; + +@end + + /** * Defines text input. */ @@ -30711,13 +34314,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe * Search for Documents. * `view-item`: Detailed page view of a Document. * * `view-item-list`: View of a panel or ordered list of Documents. * * `view-home-page`: View of the home page. * `view-category-page`: View of a - * category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user - * feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, - * e.g. in Retail online shopping * `purchase`: Purchase an item(s) - * Media-related values: * `media-play`: Start/resume watching a video, playing - * a song, etc. * `media-complete`: Finished or stopped midway through a video, - * song, etc. Custom conversion value: * `conversion`: Customer defined - * conversion event. + * category page, e.g. Home > Men > Jeans Retail-related values: * + * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * + * `purchase`: Purchase an item(s) Media-related values: * `media-play`: + * Start/resume watching a video, playing a song, etc. * `media-complete`: + * Finished or stopped midway through a video, song, etc. Custom conversion + * value: * `conversion`: Customer defined conversion event. */ @property(nonatomic, copy, nullable) NSString *eventType; @@ -31012,6 +34614,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDiscoveryEngine_GoogleMonitoringV3TimeSe */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineQuery.h b/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineQuery.h index 30c499ae7..926f52fc8 100644 --- a/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineQuery.h +++ b/Sources/GeneratedServices/DiscoveryEngine/Public/GoogleAPIClientForREST/GTLRDiscoveryEngineQuery.h @@ -280,6 +280,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -752,6 +763,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -1760,6 +1782,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -1831,6 +1864,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -2103,6 +2147,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -2913,6 +2968,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -3328,6 +3394,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -3688,6 +3765,37 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Deletes a Collection. + * + * Method: discoveryengine.projects.locations.collections.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDelete : GTLRDiscoveryEngineQuery + +/** + * Required. The full resource name of the Collection, in the format of + * `projects/{project}/locations/{location}/collections/{collection}`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningOperation. + * + * Deletes a Collection. + * + * @param name Required. The full resource name of the Collection, in the + * format of + * `projects/{project}/locations/{location}/collections/{collection}`. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsDelete + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + /** * Gets an Assistant. * @@ -4560,6 +4668,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -5158,6 +5277,46 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Gets the DataConnector. DataConnector is a singleton resource for each + * Collection. + * + * Method: discoveryengine.projects.locations.collections.getDataConnector + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsGetDataConnector : GTLRDiscoveryEngineQuery + +/** + * Required. Full resource name of DataConnector, such as + * `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. + * If the caller does not have permission to access the DataConnector, + * regardless of whether or not it exists, a PERMISSION_DENIED error is + * returned. If the requested DataConnector does not exist, a NOT_FOUND error + * is returned. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector. + * + * Gets the DataConnector. DataConnector is a singleton resource for each + * Collection. + * + * @param name Required. Full resource name of DataConnector, such as + * `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. + * If the caller does not have permission to access the DataConnector, + * regardless of whether or not it exists, a PERMISSION_DENIED error is + * returned. If the requested DataConnector does not exist, a NOT_FOUND error + * is returned. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsGetDataConnector + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + /** * 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 @@ -5211,6 +5370,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -5229,6 +5399,54 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Updates a DataConnector. + * + * Method: discoveryengine.projects.locations.collections.updateDataConnector + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsUpdateDataConnector : GTLRDiscoveryEngineQuery + +/** + * Output only. The full resource name of the Data Connector. Format: + * `projects/ * /locations/ * /collections/ * /dataConnector`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Indicates which fields in the provided DataConnector to update. Supported + * field paths include: - refresh_interval - params - auto_run_disabled - + * action_config - action_config.action_params - action_config.service_name - + * destination_configs - blocking_reasons - sync_mode - + * incremental_sync_disabled - incremental_refresh_interval Note: Support for + * these fields may vary depending on the connector type. For example, not all + * connectors support `destination_configs`. If an unsupported or unknown field + * path is provided, the request will return an INVALID_ARGUMENT error. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector. + * + * Updates a DataConnector. + * + * @param object The @c + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector to include + * in the query. + * @param name Output only. The full resource name of the Data Connector. + * Format: `projects/ * /locations/ * /collections/ * /dataConnector`. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsCollectionsUpdateDataConnector + */ ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector *)object + name:(NSString *)name; + +@end + /** * Gets index freshness metadata for Documents. Supported for website search * only. @@ -5683,6 +5901,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -6655,6 +6884,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -6726,6 +6966,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -8652,6 +8903,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -8708,6 +8970,129 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Creates a LicenseConfig + * + * Method: discoveryengine.projects.locations.licenseConfigs.create + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsCreate : GTLRDiscoveryEngineQuery + +/** + * Optional. The ID to use for the LicenseConfig, which will become the final + * component of the LicenseConfig's resource name. We are using the tier + * (product edition) name as the license config id such as `search` or + * `search_and_assistant`. + */ +@property(nonatomic, copy, nullable) NSString *licenseConfigId; + +/** + * Required. The parent resource name, such as + * `projects/{project}/locations/{location}`. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig. + * + * Creates a LicenseConfig + * + * @param object The @c + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig to include + * in the query. + * @param parent Required. The parent resource name, such as + * `projects/{project}/locations/{location}`. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsCreate + */ ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig *)object + parent:(NSString *)parent; + +@end + +/** + * Gets a LicenseConfig. + * + * Method: discoveryengine.projects.locations.licenseConfigs.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsGet : GTLRDiscoveryEngineQuery + +/** + * Required. Full resource name of LicenseConfig, such as + * `projects/{project}/locations/{location}/licenseConfigs/ *`. If the caller + * does not have permission to access the LicenseConfig, regardless of whether + * or not it exists, a PERMISSION_DENIED error is returned. If the requested + * LicenseConfig does not exist, a NOT_FOUND error is returned. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig. + * + * Gets a LicenseConfig. + * + * @param name Required. Full resource name of LicenseConfig, such as + * `projects/{project}/locations/{location}/licenseConfigs/ *`. If the caller + * does not have permission to access the LicenseConfig, regardless of + * whether or not it exists, a PERMISSION_DENIED error is returned. If the + * requested LicenseConfig does not exist, a NOT_FOUND error is returned. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Updates the LicenseConfig + * + * Method: discoveryengine.projects.locations.licenseConfigs.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsPatch : GTLRDiscoveryEngineQuery + +/** + * Immutable. Identifier. The fully qualified resource name of the license + * config. Format: + * `projects/{project}/locations/{location}/licenseConfigs/{license_config}` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. Indicates which fields in the provided LicenseConfig to update. If + * an unsupported or unknown field is provided, an INVALID_ARGUMENT error is + * returned. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig. + * + * Updates the LicenseConfig + * + * @param object The @c + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig to include + * in the query. + * @param name Immutable. Identifier. The fully qualified resource name of the + * license config. Format: + * `projects/{project}/locations/{location}/licenseConfigs/{license_config}` + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsLicenseConfigsPatch + */ ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1LicenseConfig *)object + name:(NSString *)name; + +@end + /** * 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 @@ -8761,6 +9146,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * @@ -8844,6 +9240,100 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Creates a Collection and sets up the DataConnector for it. To stop a + * DataConnector after setup, use the CollectionService.DeleteCollection + * method. + * + * Method: discoveryengine.projects.locations.setUpDataConnector + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnector : GTLRDiscoveryEngineQuery + +/** + * Required. The parent of Collection, in the format of + * `projects/{project}/locations/{location}`. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningOperation. + * + * Creates a Collection and sets up the DataConnector for it. To stop a + * DataConnector after setup, use the CollectionService.DeleteCollection + * method. + * + * @param object The @c + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest + * to include in the query. + * @param parent Required. The parent of Collection, in the format of + * `projects/{project}/locations/{location}`. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnector + */ ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest *)object + parent:(NSString *)parent; + +@end + +/** + * Creates a Collection and sets up the DataConnector for it. To stop a + * DataConnector after setup, use the CollectionService.DeleteCollection + * method. + * + * Method: discoveryengine.projects.locations.setUpDataConnectorV2 + * + * Authorization scope(s): + * @c kGTLRAuthScopeDiscoveryEngineCloudPlatform + */ +@interface GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnectorV2 : GTLRDiscoveryEngineQuery + +/** + * Required. The display name of the Collection. Should be human readable, used + * to display collections in the Console Dashboard. UTF-8 encoded string with + * limit of 1024 characters. + */ +@property(nonatomic, copy, nullable) NSString *collectionDisplayName; + +/** + * Required. The ID to use for the Collection, which will become the final + * component of the Collection's resource name. A new Collection is created as + * part of the DataConnector setup. DataConnector is a singleton resource under + * Collection, managing all DataStores of the Collection. This field must + * conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a + * length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is + * returned. + */ +@property(nonatomic, copy, nullable) NSString *collectionId; + +/** + * Required. The parent of Collection, in the format of + * `projects/{project}/locations/{location}`. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningOperation. + * + * Creates a Collection and sets up the DataConnector for it. To stop a + * DataConnector after setup, use the CollectionService.DeleteCollection + * method. + * + * @param object The @c + * GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector to include + * in the query. + * @param parent Required. The parent of Collection, in the format of + * `projects/{project}/locations/{location}`. + * + * @return GTLRDiscoveryEngineQuery_ProjectsLocationsSetUpDataConnectorV2 + */ ++ (instancetype)queryWithObject:(GTLRDiscoveryEngine_GoogleCloudDiscoveryengineV1DataConnector *)object + parent:(NSString *)parent; + +@end + /** * Default ACL configuration for use in a location of a customer's project. * Updates will only reflect to new data stores. Existing data stores will @@ -9281,6 +9771,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDiscoveryEngine_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/DisplayVideo/GTLRDisplayVideoObjects.m b/Sources/GeneratedServices/DisplayVideo/GTLRDisplayVideoObjects.m index f3fdc99c0..c05c15722 100644 --- a/Sources/GeneratedServices/DisplayVideo/GTLRDisplayVideoObjects.m +++ b/Sources/GeneratedServices/DisplayVideo/GTLRDisplayVideoObjects.m @@ -357,6 +357,7 @@ NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -859,6 +860,7 @@ NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion8 = @"SDF_VERSION_8"; NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion81 = @"SDF_VERSION_8_1"; NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion9 = @"SDF_VERSION_9"; +NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion91 = @"SDF_VERSION_9_1"; NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersionUnspecified = @"SDF_VERSION_UNSPECIFIED"; // GTLRDisplayVideo_Creative.creativeAttributes @@ -1297,6 +1299,7 @@ NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -1386,6 +1389,7 @@ NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -1475,6 +1479,7 @@ NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -1570,6 +1575,7 @@ NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -1610,6 +1616,7 @@ // GTLRDisplayVideo_FirstPartyAndPartnerAudience.audienceType NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_ActivityBased = @"ACTIVITY_BASED"; +NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_Agency = @"AGENCY"; NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_AudienceTypeUnspecified = @"AUDIENCE_TYPE_UNSPECIFIED"; NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_Commerce = @"COMMERCE"; NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_CustomerMatchContactInfo = @"CUSTOMER_MATCH_CONTACT_INFO"; @@ -1873,6 +1880,7 @@ NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -2114,6 +2122,7 @@ NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSmartclip = @"EXCHANGE_SMARTCLIP"; NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSmartrtb = @"EXCHANGE_SMARTRTB"; NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSmartstreamtv = @"EXCHANGE_SMARTSTREAMTV"; +NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSnap = @"EXCHANGE_SNAP"; NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSoundcast = @"EXCHANGE_SOUNDCAST"; NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSovrn = @"EXCHANGE_SOVRN"; NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSpotify = @"EXCHANGE_SPOTIFY"; @@ -2553,6 +2562,7 @@ NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersion8 = @"SDF_VERSION_8"; NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersion81 = @"SDF_VERSION_8_1"; NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersion9 = @"SDF_VERSION_9"; +NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersion91 = @"SDF_VERSION_9_1"; NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersionUnspecified = @"SDF_VERSION_UNSPECIFIED"; // GTLRDisplayVideo_SdfDownloadTaskMetadata.version @@ -2572,6 +2582,7 @@ NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion8 = @"SDF_VERSION_8"; NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion81 = @"SDF_VERSION_8_1"; NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion9 = @"SDF_VERSION_9"; +NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion91 = @"SDF_VERSION_9_1"; NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersionUnspecified = @"SDF_VERSION_UNSPECIFIED"; // GTLRDisplayVideo_SensitiveCategoryAssignedTargetingOptionDetails.excludedSensitiveCategory diff --git a/Sources/GeneratedServices/DisplayVideo/Public/GoogleAPIClientForREST/GTLRDisplayVideoObjects.h b/Sources/GeneratedServices/DisplayVideo/Public/GoogleAPIClientForREST/GTLRDisplayVideoObjects.h index 983ab7422..7742a2124 100644 --- a/Sources/GeneratedServices/DisplayVideo/Public/GoogleAPIClientForREST/GTLRDisplayVideoObjects.h +++ b/Sources/GeneratedServices/DisplayVideo/Public/GoogleAPIClientForREST/GTLRDisplayVideoObjects.h @@ -2140,6 +2140,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonVal * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSnap; /** * SoundCast. * @@ -5018,6 +5024,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskReques * Value: "SDF_VERSION_9" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion9; +/** + * SDF version 9.1. + * + * Value: "SDF_VERSION_9_1" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion91; /** * SDF version value is not specified or is unknown in this version. * @@ -7464,6 +7476,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOp * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSnap; /** * SoundCast. * @@ -7990,6 +8008,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchan * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSnap; /** * SoundCast. * @@ -8516,6 +8540,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchan * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSnap; /** * SoundCast. * @@ -9070,6 +9100,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDeta * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSnap; /** * SoundCast. * @@ -9287,6 +9323,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudienc * Value: "ACTIVITY_BASED" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_ActivityBased GTLR_DEPRECATED; +/** + * Audience provided by an agency. + * + * Value: "AGENCY" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_Agency; /** * Default value when type is not specified or is unknown. * @@ -10794,6 +10836,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_Ex * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSnap; /** * SoundCast. * @@ -12060,6 +12108,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_InventorySource_Exchange_Ex * Value: "EXCHANGE_SMARTSTREAMTV" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSmartstreamtv; +/** + * Snap. + * + * Value: "EXCHANGE_SNAP" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSnap; /** * SoundCast. * @@ -14420,6 +14474,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersio * Value: "SDF_VERSION_9" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersion9; +/** + * SDF version 9.1. + * + * Value: "SDF_VERSION_9_1" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_SdfConfig_Version_SdfVersion91; /** * SDF version value is not specified or is unknown in this version. * @@ -14534,6 +14594,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Ver * Value: "SDF_VERSION_9" */ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion9; +/** + * SDF version 9.1. + * + * Value: "SDF_VERSION_9_1" + */ +FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion91; /** * SDF version value is not specified or is unknown in this version. * @@ -17496,6 +17562,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSnap + * Snap. (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_AlgorithmRulesComparisonValue_ExchangeValue_ExchangeSovrn @@ -21687,6 +21755,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SDF version 9. Read the [v9 migration * guide](/display-video/api/structured-data-file/v9-migration-guide) * before migrating to this version. (Value: "SDF_VERSION_9") + * @arg @c kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersion91 + * SDF version 9.1. (Value: "SDF_VERSION_9_1") * @arg @c kGTLRDisplayVideo_CreateSdfDownloadTaskRequest_Version_SdfVersionUnspecified * SDF version value is not specified or is unknown in this version. * (Value: "SDF_VERSION_UNSPECIFIED") @@ -23687,11 +23757,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then * this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if * not otherwise specified. This field can then be updated using the UI, API, - * or Structured Data Files. *Warning*: Starting **September 8, 2025**, this - * field must be set. If not, either the value - * `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line - * item if the parent advertiser has declared that it does not serve EU - * political ads, or **the request will fail**. + * or Structured Data Files. This field must be assigned when creating a new + * line item. Otherwise, **the `advertisers.lineItems.create` request will + * fail**. * * Likely values: * @arg @c kGTLRDisplayVideo_DuplicateLineItemRequest_ContainsEuPoliticalAds_ContainsEuPoliticalAdvertising @@ -24119,6 +24187,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSnap + * Snap. (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_ExchangeAssignedTargetingOptionDetails_Exchange_ExchangeSovrn @@ -24326,6 +24396,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSnap + * Snap. (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_ExchangeConfigEnabledExchange_Exchange_ExchangeSovrn @@ -24534,6 +24606,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSnap Snap. + * (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_ExchangeReviewStatus_Exchange_ExchangeSovrn @@ -24745,6 +24819,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSnap + * Snap. (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_ExchangeTargetingOptionDetails_Exchange_ExchangeSovrn @@ -24893,6 +24969,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * @arg @c kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_ActivityBased * Audience was created based on campaign activity. (Value: * "ACTIVITY_BASED") + * @arg @c kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_Agency + * Audience provided by an agency. (Value: "AGENCY") * @arg @c kGTLRDisplayVideo_FirstPartyAndPartnerAudience_AudienceType_AudienceTypeUnspecified * Default value when type is not specified or is unknown. (Value: * "AUDIENCE_TYPE_UNSPECIFIED") @@ -25475,11 +25553,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then * this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if * not otherwise specified. This field can then be updated using the UI, API, - * or Structured Data Files. *Warning*: Starting **September 8, 2025**, this - * field must be set. If not, either the value - * `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line - * item if the parent advertiser has declared that it does not serve EU - * political ads, or **the request will fail**. + * or Structured Data Files. This field must be assigned when creating a new + * line item. Otherwise, **the `advertisers.lineItems.create` request will + * fail**. * * Likely values: * @arg @c kGTLRDisplayVideo_GenerateDefaultLineItemRequest_ContainsEuPoliticalAds_ContainsEuPoliticalAdvertising @@ -26152,6 +26228,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSnap Snap. + * (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_GuaranteedOrder_Exchange_ExchangeSovrn Sovrn. @@ -27260,6 +27338,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * SmartRTB+. (Value: "EXCHANGE_SMARTRTB") * @arg @c kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSmartstreamtv * SmartstreamTv. (Value: "EXCHANGE_SMARTSTREAMTV") + * @arg @c kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSnap Snap. + * (Value: "EXCHANGE_SNAP") * @arg @c kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSoundcast * SoundCast. (Value: "EXCHANGE_SOUNDCAST") * @arg @c kGTLRDisplayVideo_InventorySource_Exchange_ExchangeSovrn Sovrn. @@ -28021,11 +28101,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then * this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if * not otherwise specified. This field can then be updated using the UI, API, - * or Structured Data Files. *Warning*: Starting **September 8, 2025**, this - * field must be set when creating a new line item. If not, either the value - * `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent - * advertiser has declared that it does not serve EU political ads, or **the - * `advertisers.lineItems.create` request will fail**. + * or Structured Data Files. This field must be assigned when creating a new + * line item. Otherwise, **the `advertisers.lineItems.create` request will + * fail**. * * Likely values: * @arg @c kGTLRDisplayVideo_LineItem_ContainsEuPoliticalAds_ContainsEuPoliticalAdvertising @@ -31571,6 +31649,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * Read the [v9 migration * guide](/display-video/api/structured-data-file/v9-migration-guide) * before migrating to this version. (Value: "SDF_VERSION_9") + * @arg @c kGTLRDisplayVideo_SdfConfig_Version_SdfVersion91 SDF version 9.1. + * (Value: "SDF_VERSION_9_1") * @arg @c kGTLRDisplayVideo_SdfConfig_Version_SdfVersionUnspecified SDF * version value is not specified or is unknown in this version. (Value: * "SDF_VERSION_UNSPECIFIED") @@ -31653,6 +31733,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDisplayVideo_YoutubeVideoDetails_Unavail * version 9. Read the [v9 migration * guide](/display-video/api/structured-data-file/v9-migration-guide) * before migrating to this version. (Value: "SDF_VERSION_9") + * @arg @c kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersion91 SDF + * version 9.1. (Value: "SDF_VERSION_9_1") * @arg @c kGTLRDisplayVideo_SdfDownloadTaskMetadata_Version_SdfVersionUnspecified * SDF version value is not specified or is unknown in this version. * (Value: "SDF_VERSION_UNSPECIFIED") diff --git a/Sources/GeneratedServices/Docs/GTLRDocsObjects.m b/Sources/GeneratedServices/Docs/GTLRDocsObjects.m index e3afa6f29..e8f2c0688 100644 --- a/Sources/GeneratedServices/Docs/GTLRDocsObjects.m +++ b/Sources/GeneratedServices/Docs/GTLRDocsObjects.m @@ -1294,6 +1294,16 @@ @implementation GTLRDocs_InsertPageBreakRequest @end +// ---------------------------------------------------------------------------- +// +// GTLRDocs_InsertPersonRequest +// + +@implementation GTLRDocs_InsertPersonRequest +@dynamic endOfSegmentLocation, location, personProperties; +@end + + // ---------------------------------------------------------------------------- // // GTLRDocs_InsertSectionBreakRequest @@ -1952,12 +1962,12 @@ @implementation GTLRDocs_Request createParagraphBullets, deleteContentRange, deleteFooter, deleteHeader, deleteNamedRange, deleteParagraphBullets, deletePositionedObject, deleteTableColumn, deleteTableRow, insertInlineImage, insertPageBreak, - insertSectionBreak, insertTable, insertTableColumn, insertTableRow, - insertText, mergeTableCells, pinTableHeaderRows, replaceAllText, - replaceImage, replaceNamedRangeContent, unmergeTableCells, - updateDocumentStyle, updateParagraphStyle, updateSectionStyle, - updateTableCellStyle, updateTableColumnProperties, updateTableRowStyle, - updateTextStyle; + insertPerson, insertSectionBreak, insertTable, insertTableColumn, + insertTableRow, insertText, mergeTableCells, pinTableHeaderRows, + replaceAllText, replaceImage, replaceNamedRangeContent, + unmergeTableCells, updateDocumentStyle, updateParagraphStyle, + updateSectionStyle, updateTableCellStyle, updateTableColumnProperties, + updateTableRowStyle, updateTextStyle; @end diff --git a/Sources/GeneratedServices/Docs/Public/GoogleAPIClientForREST/GTLRDocsObjects.h b/Sources/GeneratedServices/Docs/Public/GoogleAPIClientForREST/GTLRDocsObjects.h index b5f4df93b..5614e1ded 100644 --- a/Sources/GeneratedServices/Docs/Public/GoogleAPIClientForREST/GTLRDocsObjects.h +++ b/Sources/GeneratedServices/Docs/Public/GoogleAPIClientForREST/GTLRDocsObjects.h @@ -94,6 +94,7 @@ @class GTLRDocs_InsertInlineImageResponse; @class GTLRDocs_InsertInlineSheetsChartResponse; @class GTLRDocs_InsertPageBreakRequest; +@class GTLRDocs_InsertPersonRequest; @class GTLRDocs_InsertSectionBreakRequest; @class GTLRDocs_InsertTableColumnRequest; @class GTLRDocs_InsertTableRequest; @@ -3525,6 +3526,31 @@ FOUNDATION_EXTERN NSString * const kGTLRDocs_TextStyle_BaselineOffset_Superscrip @end +/** + * Inserts a person mention. + */ +@interface GTLRDocs_InsertPersonRequest : GTLRObject + +/** + * Inserts the person at the end of a header, footer, footnote or the document + * body. + */ +@property(nonatomic, strong, nullable) GTLRDocs_EndOfSegmentLocation *endOfSegmentLocation; + +/** + * Inserts the person at a specific index in the document. The person mention + * must be inserted inside the bounds of an existing Paragraph. For instance, + * it cannot be inserted at a table's start index (i.e. between the table and + * its preceding paragraph). People cannot be inserted inside an equation. + */ +@property(nonatomic, strong, nullable) GTLRDocs_Location *location; + +/** The properties of the person mention to insert. */ +@property(nonatomic, strong, nullable) GTLRDocs_PersonProperties *personProperties; + +@end + + /** * Inserts a section break at the given location. A newline character will be * inserted before the section break. @@ -4930,15 +4956,12 @@ FOUNDATION_EXTERN NSString * const kGTLRDocs_TextStyle_BaselineOffset_Superscrip */ @interface GTLRDocs_PersonProperties : GTLRObject -/** - * Output only. The email address linked to this Person. This field is always - * present. - */ +/** The email address linked to this Person. This field is always present. */ @property(nonatomic, copy, nullable) NSString *email; /** - * Output only. The name of the person if it's displayed in the link text - * instead of the person's email address. + * The name of the person if it's displayed in the link text instead of the + * person's email address. */ @property(nonatomic, copy, nullable) NSString *name; @@ -5354,6 +5377,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDocs_TextStyle_BaselineOffset_Superscrip /** Inserts a page break at the specified location. */ @property(nonatomic, strong, nullable) GTLRDocs_InsertPageBreakRequest *insertPageBreak; +/** Inserts a person mention. */ +@property(nonatomic, strong, nullable) GTLRDocs_InsertPersonRequest *insertPerson; + /** Inserts a section break at the specified location. */ @property(nonatomic, strong, nullable) GTLRDocs_InsertSectionBreakRequest *insertSectionBreak; diff --git a/Sources/GeneratedServices/Document/GTLRDocumentObjects.m b/Sources/GeneratedServices/Document/GTLRDocumentObjects.m index b63360bad..2f83004bb 100644 --- a/Sources/GeneratedServices/Document/GTLRDocumentObjects.m +++ b/Sources/GeneratedServices/Document/GTLRDocumentObjects.m @@ -15,6 +15,11 @@ // ---------------------------------------------------------------------------- // Constants +// GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule.alignmentType +NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeHorizontal = @"ALIGNMENT_TYPE_HORIZONTAL"; +NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeUnspecified = @"ALIGNMENT_TYPE_UNSPECIFIED"; +NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeVertical = @"ALIGNMENT_TYPE_VERTICAL"; + // GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation.validationOperator NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation_ValidationOperator_OperationTypeEq = @"OPERATION_TYPE_EQ"; NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation_ValidationOperator_OperationTypeGe = @"OPERATION_TYPE_GE"; @@ -284,8 +289,8 @@ @implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorIn // @implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule -@dynamic descriptionProperty, fieldOccurrences, fieldRegex, formValidation, - name; +@dynamic childAlignmentRule, descriptionProperty, entityAlignmentRule, + fieldOccurrences, fieldRegex, formValidation, name; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"descriptionProperty" : @"description" }; @@ -294,6 +299,34 @@ @implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorIn @end +// ---------------------------------------------------------------------------- +// +// GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule +// + +@implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule +@dynamic alignmentType, tolerance; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule +// + +@implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule +@dynamic alignmentRule, childFields, parentField; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"childFields" : [GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant @@ -304,6 +337,24 @@ @implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorIn @end +// ---------------------------------------------------------------------------- +// +// GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule +// + +@implementation GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule +@dynamic alignmentRule, fields; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"fields" : [GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField @@ -3371,11 +3422,12 @@ + (Class)classForAdditionalProperties { // @implementation GTLRDocument_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRDocument_GoogleLongrunningOperation class] + @"operations" : [GTLRDocument_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Document/GTLRDocumentQuery.m b/Sources/GeneratedServices/Document/GTLRDocumentQuery.m index 63cd90b4e..089d8d3b7 100644 --- a/Sources/GeneratedServices/Document/GTLRDocumentQuery.m +++ b/Sources/GeneratedServices/Document/GTLRDocumentQuery.m @@ -141,7 +141,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRDocumentQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentObjects.h b/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentObjects.h index 6772c1230..7bb738c60 100644 --- a/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentObjects.h +++ b/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentObjects.h @@ -17,7 +17,10 @@ #endif @class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule; +@class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule; +@class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule; @class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant; +@class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule; @class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField; @class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences; @class GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex; @@ -181,6 +184,16 @@ NS_ASSUME_NONNULL_BEGIN // ---------------------------------------------------------------------------- // Constants - For some of the classes' properties below. +// ---------------------------------------------------------------------------- +// GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule.alignmentType + +/** Value: "ALIGNMENT_TYPE_HORIZONTAL" */ +FOUNDATION_EXTERN NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeHorizontal; +/** Value: "ALIGNMENT_TYPE_UNSPECIFIED" */ +FOUNDATION_EXTERN NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeUnspecified; +/** Value: "ALIGNMENT_TYPE_VERTICAL" */ +FOUNDATION_EXTERN NSString * const kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeVertical; + // ---------------------------------------------------------------------------- // GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation.validationOperator @@ -1358,6 +1371,8 @@ FOUNDATION_EXTERN NSString * const kGTLRDocument_GoogleCloudDocumentaiV1TrainPro */ @interface GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule : GTLRObject +@property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule *childAlignmentRule; + /** * Description of the validation rule. This has no use but for documentation * @@ -1365,6 +1380,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDocument_GoogleCloudDocumentaiV1TrainPro */ @property(nonatomic, copy, nullable) NSString *descriptionProperty; +@property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule *entityAlignmentRule; @property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences *fieldOccurrences; @property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex *fieldRegex; @property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation *formValidation; @@ -1375,6 +1391,54 @@ FOUNDATION_EXTERN NSString * const kGTLRDocument_GoogleCloudDocumentaiV1TrainPro @end +/** + * A rule for checking field alignment. Horizontal alignment checks if fields + * are on the same row by comparing y-coordinates of bounding box centers, + * while vertical alignment checks if fields are on the same column by + * comparing x-coordinates of bounding box centers. + */ +@interface GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule : GTLRObject + +/** + * alignmentType + * + * Likely values: + * @arg @c kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeHorizontal + * Value "ALIGNMENT_TYPE_HORIZONTAL" + * @arg @c kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeUnspecified + * Value "ALIGNMENT_TYPE_UNSPECIFIED" + * @arg @c kGTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule_AlignmentType_AlignmentTypeVertical + * Value "ALIGNMENT_TYPE_VERTICAL" + */ +@property(nonatomic, copy, nullable) NSString *alignmentType; + +/** + * The tolerance to use when comparing coordinates. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *tolerance; + +@end + + +/** + * A rule that aligns specified child fields with a parent field. + */ +@interface GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule : GTLRObject + +/** The alignment rule to apply to the child fields. */ +@property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule *alignmentRule; + +/** The child fields to be aligned within the parent field. */ +@property(nonatomic, strong, nullable) NSArray *childFields; + +/** The full path of the parent field. */ +@property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField *parentField; + +@end + + /** * The constant value used in the validation rules. */ @@ -1390,6 +1454,20 @@ FOUNDATION_EXTERN NSString * const kGTLRDocument_GoogleCloudDocumentaiV1TrainPro @end +/** + * A rule that aligns specified fields with each other. + */ +@interface GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule : GTLRObject + +/** The alignment rule to apply to the fields. */ +@property(nonatomic, strong, nullable) GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule *alignmentRule; + +/** The fields to be aligned. */ +@property(nonatomic, strong, nullable) NSArray *fields; + +@end + + /** * GTLRDocument_CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField */ @@ -6805,7 +6883,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDocument_GoogleCloudDocumentaiV1TrainPro @interface GTLRDocument_GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions : GTLRObject /** - * Training method to use for CDE training. + * Optional. Training method to use for CDE training. * * Likely values: * @arg @c kGTLRDocument_GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions_TrainingMethod_ModelBased @@ -7024,6 +7102,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDocument_GoogleCloudDocumentaiV1TrainPro */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentQuery.h b/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentQuery.h index d660bce37..16487e07b 100644 --- a/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentQuery.h +++ b/Sources/GeneratedServices/Document/Public/GoogleAPIClientForREST/GTLRDocumentQuery.h @@ -137,8 +137,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRDocumentQuery_ProjectsLocationsList : GTLRDocumentQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -276,6 +276,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRDocument_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveObjects.h b/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveObjects.h index dd4f966e3..3fee970f3 100644 --- a/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveObjects.h +++ b/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveObjects.h @@ -83,8 +83,8 @@ NS_ASSUME_NONNULL_BEGIN // GTLRDrive_ResolveAccessProposalRequest.action /** - * The user accepts the proposal. Note: If this action is used, the `role` - * field must have at least one value. + * The user accepts the access proposal. Note: If this action is used, the + * `role` field must have at least one value. * * Value: "ACCEPT" */ @@ -96,7 +96,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Actio */ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Action_ActionUnspecified; /** - * The user denies the proposal + * The user denies the access proposal. * * Value: "DENY" */ @@ -300,49 +300,56 @@ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Actio /** - * The Access Proposal resource for outstanding access proposals on a file + * Manage outstanding access proposals on a file. */ @interface GTLRDrive_AccessProposal : GTLRObject -/** The creation time */ +/** The creation time. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** The file id that the proposal for access is on */ +/** The file ID that the proposal for access is on. */ @property(nonatomic, copy, nullable) NSString *fileId; -/** The id of the access proposal */ +/** The ID of the access proposal. */ @property(nonatomic, copy, nullable) NSString *proposalId; -/** The email address of the user that will receive permissions if accepted */ +/** + * The email address of the user that will receive permissions, if accepted. + */ @property(nonatomic, copy, nullable) NSString *recipientEmailAddress; -/** The email address of the requesting user */ +/** The email address of the requesting user. */ @property(nonatomic, copy, nullable) NSString *requesterEmailAddress; -/** The message that the requester added to the proposal */ +/** The message that the requester added to the proposal. */ @property(nonatomic, copy, nullable) NSString *requestMessage; -/** A wrapper for the role and view of an access proposal. */ +/** + * A wrapper for the role and view of an access proposal. For more information, + * see [Roles and + * permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). + */ @property(nonatomic, strong, nullable) NSArray *rolesAndViews; @end /** - * A wrapper for the role and view of an access proposal. + * A wrapper for the role and view of an access proposal. For more information, + * see [Roles and + * permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). */ @interface GTLRDrive_AccessProposalRoleAndView : GTLRObject /** - * The role that was proposed by the requester New values may be added in the - * future, but the following are currently possible: * `writer` * `commenter` * - * `reader` + * The role that was proposed by the requester. The supported values are: * + * `writer` * `commenter` * `reader` */ @property(nonatomic, copy, nullable) NSString *role; /** * Indicates the view for this access proposal. Only populated for proposals - * that belong to a view. `published` is the only supported value. + * that belong to a view. Only `published` is supported. */ @property(nonatomic, copy, nullable) NSString *view; @@ -2739,7 +2746,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Actio /** - * The response to an Access Proposal list request. + * The response to an access proposal list request. * * @note This class supports NSFastEnumeration and indexed subscripting over * its "accessProposals" property. If returned as the result of a query, @@ -2749,7 +2756,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Actio @interface GTLRDrive_ListAccessProposalsResponse : GTLRCollectionObject /** - * The list of Access Proposals. This field is only populated in v3 and v3beta. + * The list of access proposals. This field is only populated in Drive API v3. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. @@ -3204,27 +3211,29 @@ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Actio @interface GTLRDrive_ResolveAccessProposalRequest : GTLRObject /** - * Required. The action to take on the AccessProposal. + * Required. The action to take on the access proposal. * * Likely values: * @arg @c kGTLRDrive_ResolveAccessProposalRequest_Action_Accept The user - * accepts the proposal. Note: If this action is used, the `role` field - * must have at least one value. (Value: "ACCEPT") + * accepts the access proposal. Note: If this action is used, the `role` + * field must have at least one value. (Value: "ACCEPT") * @arg @c kGTLRDrive_ResolveAccessProposalRequest_Action_ActionUnspecified * Unspecified action (Value: "ACTION_UNSPECIFIED") * @arg @c kGTLRDrive_ResolveAccessProposalRequest_Action_Deny The user - * denies the proposal (Value: "DENY") + * denies the access proposal. (Value: "DENY") */ @property(nonatomic, copy, nullable) NSString *action; /** - * Optional. The roles the approver has allowed, if any. Note: This field is - * required for the `ACCEPT` action. + * Optional. The roles that the approver has allowed, if any. For more + * information, see [Roles and + * permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). + * Note: This field is required for the `ACCEPT` action. */ @property(nonatomic, strong, nullable) NSArray *role; /** - * Optional. Whether to send an email to the requester when the AccessProposal + * Optional. Whether to send an email to the requester when the access proposal * is denied or accepted. * * Uses NSNumber of boolValue. @@ -3233,8 +3242,7 @@ FOUNDATION_EXTERN NSString * const kGTLRDrive_ResolveAccessProposalRequest_Actio /** * Optional. Indicates the view for this access proposal. This should only be - * set when the proposal belongs to a view. `published` is the only supported - * value. + * set when the proposal belongs to a view. Only `published` is supported. */ @property(nonatomic, copy, nullable) NSString *view; diff --git a/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveQuery.h b/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveQuery.h index 1124705d6..81c0b8e3e 100644 --- a/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveQuery.h +++ b/Sources/GeneratedServices/Drive/Public/GoogleAPIClientForREST/GTLRDriveQuery.h @@ -94,7 +94,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; @end /** - * Retrieves an AccessProposal by ID. + * Retrieves an access proposal by ID. For more information, see [Manage + * pending access + * proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). * * Method: drive.accessproposals.get * @@ -107,19 +109,21 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; */ @interface GTLRDriveQuery_AccessproposalsGet : GTLRDriveQuery -/** Required. The id of the item the request is on. */ +/** Required. The ID of the item the request is on. */ @property(nonatomic, copy, nullable) NSString *fileId; -/** Required. The id of the access proposal to resolve. */ +/** Required. The ID of the access proposal to resolve. */ @property(nonatomic, copy, nullable) NSString *proposalId; /** * Fetches a @c GTLRDrive_AccessProposal. * - * Retrieves an AccessProposal by ID. + * Retrieves an access proposal by ID. For more information, see [Manage + * pending access + * proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). * - * @param fileId Required. The id of the item the request is on. - * @param proposalId Required. The id of the access proposal to resolve. + * @param fileId Required. The ID of the item the request is on. + * @param proposalId Required. The ID of the access proposal to resolve. * * @return GTLRDriveQuery_AccessproposalsGet */ @@ -129,8 +133,11 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; @end /** - * List the AccessProposals on a file. Note: Only approvers are able to list - * AccessProposals on a file. If the user is not an approver, returns a 403. + * List the access proposals on a file. For more information, see [Manage + * pending access + * proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). + * Note: Only approvers are able to list access proposals on a file. If the + * user isn't an approver, a 403 error is returned. * * Method: drive.accessproposals.list * @@ -143,10 +150,10 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; */ @interface GTLRDriveQuery_AccessproposalsList : GTLRDriveQuery -/** Required. The id of the item the request is on. */ +/** Required. The ID of the item the request is on. */ @property(nonatomic, copy, nullable) NSString *fileId; -/** Optional. The number of results per page */ +/** Optional. The number of results per page. */ @property(nonatomic, assign) NSInteger pageSize; /** Optional. The continuation token on the list of access requests. */ @@ -155,10 +162,13 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; /** * Fetches a @c GTLRDrive_ListAccessProposalsResponse. * - * List the AccessProposals on a file. Note: Only approvers are able to list - * AccessProposals on a file. If the user is not an approver, returns a 403. + * List the access proposals on a file. For more information, see [Manage + * pending access + * proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). + * Note: Only approvers are able to list access proposals on a file. If the + * user isn't an approver, a 403 error is returned. * - * @param fileId Required. The id of the item the request is on. + * @param fileId Required. The ID of the item the request is on. * * @return GTLRDriveQuery_AccessproposalsList * @@ -171,7 +181,9 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; @end /** - * Used to approve or deny an Access Proposal. + * Approves or denies an access proposal. For more information, see [Manage + * pending access + * proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). * * Method: drive.accessproposals.resolve * @@ -181,22 +193,24 @@ FOUNDATION_EXTERN NSString * const kGTLRDriveCorpusUser; */ @interface GTLRDriveQuery_AccessproposalsResolve : GTLRDriveQuery -/** Required. The id of the item the request is on. */ +/** Required. The ID of the item the request is on. */ @property(nonatomic, copy, nullable) NSString *fileId; -/** Required. The id of the access proposal to resolve. */ +/** Required. The ID of the access proposal to resolve. */ @property(nonatomic, copy, nullable) NSString *proposalId; /** * Upon successful completion, the callback's object and error parameters will * be nil. This query does not fetch an object. * - * Used to approve or deny an Access Proposal. + * Approves or denies an access proposal. For more information, see [Manage + * pending access + * proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). * * @param object The @c GTLRDrive_ResolveAccessProposalRequest to include in * the query. - * @param fileId Required. The id of the item the request is on. - * @param proposalId Required. The id of the access proposal to resolve. + * @param fileId Required. The ID of the item the request is on. + * @param proposalId Required. The ID of the access proposal to resolve. * * @return GTLRDriveQuery_AccessproposalsResolve */ diff --git a/Sources/GeneratedServices/Eventarc/GTLREventarcObjects.m b/Sources/GeneratedServices/Eventarc/GTLREventarcObjects.m index 1003d2332..13e4085da 100644 --- a/Sources/GeneratedServices/Eventarc/GTLREventarcObjects.m +++ b/Sources/GeneratedServices/Eventarc/GTLREventarcObjects.m @@ -321,7 +321,8 @@ @implementation GTLREventarc_GKE @implementation GTLREventarc_GoogleApiSource @dynamic annotations, createTime, cryptoKeyName, destination, displayName, ETag, - labels, loggingConfig, name, uid, updateTime; + labels, loggingConfig, name, organizationSubscription, + projectSubscriptions, uid, updateTime; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"ETag" : @"etag" }; @@ -961,6 +962,16 @@ @implementation GTLREventarc_OperationMetadata @end +// ---------------------------------------------------------------------------- +// +// GTLREventarc_OrganizationSubscription +// + +@implementation GTLREventarc_OrganizationSubscription +@dynamic enabled; +@end + + // ---------------------------------------------------------------------------- // // GTLREventarc_Pipeline @@ -1037,6 +1048,24 @@ @implementation GTLREventarc_Policy @end +// ---------------------------------------------------------------------------- +// +// GTLREventarc_ProjectSubscriptions +// + +@implementation GTLREventarc_ProjectSubscriptions +@dynamic list; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"list" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLREventarc_Provider diff --git a/Sources/GeneratedServices/Eventarc/Public/GoogleAPIClientForREST/GTLREventarcObjects.h b/Sources/GeneratedServices/Eventarc/Public/GoogleAPIClientForREST/GTLREventarcObjects.h index 99130a566..9018eb65a 100644 --- a/Sources/GeneratedServices/Eventarc/Public/GoogleAPIClientForREST/GTLREventarcObjects.h +++ b/Sources/GeneratedServices/Eventarc/Public/GoogleAPIClientForREST/GTLREventarcObjects.h @@ -62,10 +62,12 @@ @class GTLREventarc_MessageBus_Annotations; @class GTLREventarc_MessageBus_Labels; @class GTLREventarc_NetworkConfig; +@class GTLREventarc_OrganizationSubscription; @class GTLREventarc_Pipeline; @class GTLREventarc_Pipeline_Annotations; @class GTLREventarc_Pipeline_Labels; @class GTLREventarc_Policy; +@class GTLREventarc_ProjectSubscriptions; @class GTLREventarc_Provider; @class GTLREventarc_Pubsub; @class GTLREventarc_StateCondition; @@ -1101,6 +1103,18 @@ FOUNDATION_EXTERN NSString * const kGTLREventarc_StateCondition_Code_Unknown; */ @property(nonatomic, copy, nullable) NSString *name; +/** + * Optional. Config to enable subscribing to events from all projects in the + * GoogleApiSource's org. + */ +@property(nonatomic, strong, nullable) GTLREventarc_OrganizationSubscription *organizationSubscription; + +/** + * Optional. Config to enable subscribing to all events from a list of + * projects. All the projects must be in the same org as the GoogleApiSource. + */ +@property(nonatomic, strong, nullable) GTLREventarc_ProjectSubscriptions *projectSubscriptions; + /** * Output only. Server assigned unique identifier for the channel. The value is * a UUID4 string and guaranteed to remain unchanged until the resource is @@ -2300,6 +2314,21 @@ FOUNDATION_EXTERN NSString * const kGTLREventarc_StateCondition_Code_Unknown; @end +/** + * Config to enabled subscribing to events from other projects in the org. + */ +@interface GTLREventarc_OrganizationSubscription : GTLRObject + +/** + * Required. Enable org level subscription. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enabled; + +@end + + /** * A representation of the Pipeline resource. */ @@ -2523,6 +2552,23 @@ FOUNDATION_EXTERN NSString * const kGTLREventarc_StateCondition_Code_Unknown; @end +/** + * Config to enable subscribing to all events from a list of projects. + */ +@interface GTLREventarc_ProjectSubscriptions : GTLRObject + +/** + * Required. A list of projects to receive events from. All the projects must + * be in the same org. The listed projects should have the format + * project/{identifier} where identifier can be either the project id for + * project number. A single list may contain both formats. At most 100 projects + * can be listed. + */ +@property(nonatomic, strong, nullable) NSArray *list; + +@end + + /** * A representation of the Provider resource. */ diff --git a/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionObjects.m b/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionObjects.m index f9d7410d4..5d93aad92 100644 --- a/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionObjects.m +++ b/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionObjects.m @@ -560,11 +560,12 @@ @implementation GTLRFirebaseAppDistribution_GoogleLongrunningCancelOperationRequ // @implementation GTLRFirebaseAppDistribution_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRFirebaseAppDistribution_GoogleLongrunningOperation class] + @"operations" : [GTLRFirebaseAppDistribution_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionQuery.m b/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionQuery.m index 10083f856..ab154a3bd 100644 --- a/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionQuery.m +++ b/Sources/GeneratedServices/FirebaseAppDistribution/GTLRFirebaseAppDistributionQuery.m @@ -278,7 +278,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRFirebaseAppDistributionQuery_ProjectsAppsReleasesOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionObjects.h b/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionObjects.h index db5e3a59d..8e8107828 100644 --- a/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionObjects.h +++ b/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionObjects.h @@ -1416,6 +1416,13 @@ FOUNDATION_EXTERN NSString * const kGTLRFirebaseAppDistribution_GoogleFirebaseAp */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionQuery.h b/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionQuery.h index 82e9879ea..27ea33a31 100644 --- a/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionQuery.h +++ b/Sources/GeneratedServices/FirebaseAppDistribution/Public/GoogleAPIClientForREST/GTLRFirebaseAppDistributionQuery.h @@ -526,6 +526,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c * GTLRFirebaseAppDistribution_GoogleLongrunningListOperationsResponse. diff --git a/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectObjects.m b/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectObjects.m index 7ad184feb..78f8ff1fb 100644 --- a/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectObjects.m +++ b/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectObjects.m @@ -345,6 +345,30 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRFirebaseDataConnect_ImpersonateRequest +// + +@implementation GTLRFirebaseDataConnect_ImpersonateRequest +@dynamic extensions, operationName, variables; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRFirebaseDataConnect_ImpersonateRequest_Variables +// + +@implementation GTLRFirebaseDataConnect_ImpersonateRequest_Variables + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRFirebaseDataConnect_Impersonation diff --git a/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectQuery.m b/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectQuery.m index c85e8678e..1990a02a8 100644 --- a/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectQuery.m +++ b/Sources/GeneratedServices/FirebaseDataConnect/GTLRFirebaseDataConnectQuery.m @@ -272,6 +272,60 @@ + (instancetype)queryWithName:(NSString *)name { @end +@implementation GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateMutation + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLRFirebaseDataConnect_ImpersonateRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:impersonateMutation"; + GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateMutation *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRFirebaseDataConnect_GraphqlResponse class]; + query.loggingName = @"firebasedataconnect.projects.locations.services.connectors.impersonateMutation"; + return query; +} + +@end + +@implementation GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateQuery + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLRFirebaseDataConnect_ImpersonateRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:impersonateQuery"; + GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateQuery *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRFirebaseDataConnect_GraphqlResponse class]; + query.loggingName = @"firebasedataconnect.projects.locations.services.connectors.impersonateQuery"; + return query; +} + +@end + @implementation GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsList @dynamic filter, orderBy, pageSize, pageToken, parent; @@ -441,6 +495,33 @@ + (instancetype)queryWithName:(NSString *)name { @end +@implementation GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesIntrospectGraphql + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLRFirebaseDataConnect_GraphqlRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:introspectGraphql"; + GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesIntrospectGraphql *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRFirebaseDataConnect_GraphqlResponse class]; + query.loggingName = @"firebasedataconnect.projects.locations.services.introspectGraphql"; + return query; +} + +@end + @implementation GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesList @dynamic filter, orderBy, pageSize, pageToken, parent; diff --git a/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectObjects.h b/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectObjects.h index c124089ce..22427f7ba 100644 --- a/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectObjects.h +++ b/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectObjects.h @@ -33,6 +33,7 @@ @class GTLRFirebaseDataConnect_GraphqlRequest_Variables; @class GTLRFirebaseDataConnect_GraphqlRequestExtensions; @class GTLRFirebaseDataConnect_GraphqlResponse_Data; +@class GTLRFirebaseDataConnect_ImpersonateRequest_Variables; @class GTLRFirebaseDataConnect_Impersonation; @class GTLRFirebaseDataConnect_Impersonation_AuthClaims; @class GTLRFirebaseDataConnect_Location; @@ -822,6 +823,39 @@ FOUNDATION_EXTERN NSString * const kGTLRFirebaseDataConnect_PostgreSql_SchemaVal @end +/** + * The Impersonate request to Firebase Data Connect. + */ +@interface GTLRFirebaseDataConnect_ImpersonateRequest : GTLRObject + +/** Optional. Additional GraphQL request information. */ +@property(nonatomic, strong, nullable) GTLRFirebaseDataConnect_GraphqlRequestExtensions *extensions; + +/** + * Required. The name of the GraphQL operation name. Required because all + * Connector operations must be named. See + * https://graphql.org/learn/queries/#operation-name. + */ +@property(nonatomic, copy, nullable) NSString *operationName; + +/** Optional. Values for GraphQL variables provided in this request. */ +@property(nonatomic, strong, nullable) GTLRFirebaseDataConnect_ImpersonateRequest_Variables *variables; + +@end + + +/** + * Optional. Values for GraphQL variables provided in this request. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRFirebaseDataConnect_ImpersonateRequest_Variables : GTLRObject +@end + + /** * Impersonation configures the Firebase Auth context to impersonate. */ diff --git a/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectQuery.h b/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectQuery.h index 98e01d73f..777fa2f91 100644 --- a/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectQuery.h +++ b/Sources/GeneratedServices/FirebaseDataConnect/Public/GoogleAPIClientForREST/GTLRFirebaseDataConnectQuery.h @@ -74,8 +74,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRFirebaseDataConnectQuery_ProjectsLocationsList : GTLRFirebaseDataConnectQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -508,6 +508,92 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Impersonate a mutation defined on a Firebase Data Connect connector. It + * grants the admin SDK access to mutations defined in the given connector. The + * caller can choose to impersonate a particular Firebase Auth user, or skip + * \@auth completely. + * + * Method: firebasedataconnect.projects.locations.services.connectors.impersonateMutation + * + * Authorization scope(s): + * @c kGTLRAuthScopeFirebaseDataConnectCloudPlatform + */ +@interface GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateMutation : GTLRFirebaseDataConnectQuery + +/** + * Required. The resource name of the connector to find the predefined + * query/mutation, in the format: ``` + * projects/{project}/locations/{location}/services/{service}/connectors/{connector} + * ``` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRFirebaseDataConnect_GraphqlResponse. + * + * Impersonate a mutation defined on a Firebase Data Connect connector. It + * grants the admin SDK access to mutations defined in the given connector. The + * caller can choose to impersonate a particular Firebase Auth user, or skip + * \@auth completely. + * + * @param object The @c GTLRFirebaseDataConnect_ImpersonateRequest to include + * in the query. + * @param name Required. The resource name of the connector to find the + * predefined query/mutation, in the format: ``` + * projects/{project}/locations/{location}/services/{service}/connectors/{connector} + * ``` + * + * @return GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateMutation + */ ++ (instancetype)queryWithObject:(GTLRFirebaseDataConnect_ImpersonateRequest *)object + name:(NSString *)name; + +@end + +/** + * Impersonate a query defined on a Firebase Data Connect connector. It grants + * the admin SDK access to queries defined in the given connector. The caller + * can choose to impersonate a particular Firebase Auth user, or skip \@auth + * completely. + * + * Method: firebasedataconnect.projects.locations.services.connectors.impersonateQuery + * + * Authorization scope(s): + * @c kGTLRAuthScopeFirebaseDataConnectCloudPlatform + */ +@interface GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateQuery : GTLRFirebaseDataConnectQuery + +/** + * Required. The resource name of the connector to find the predefined + * query/mutation, in the format: ``` + * projects/{project}/locations/{location}/services/{service}/connectors/{connector} + * ``` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRFirebaseDataConnect_GraphqlResponse. + * + * Impersonate a query defined on a Firebase Data Connect connector. It grants + * the admin SDK access to queries defined in the given connector. The caller + * can choose to impersonate a particular Firebase Auth user, or skip \@auth + * completely. + * + * @param object The @c GTLRFirebaseDataConnect_ImpersonateRequest to include + * in the query. + * @param name Required. The resource name of the connector to find the + * predefined query/mutation, in the format: ``` + * projects/{project}/locations/{location}/services/{service}/connectors/{connector} + * ``` + * + * @return GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesConnectorsImpersonateQuery + */ ++ (instancetype)queryWithObject:(GTLRFirebaseDataConnect_ImpersonateRequest *)object + name:(NSString *)name; + +@end + /** * Lists Connectors in a given project and location. * @@ -878,6 +964,51 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Execute introspection query against the Firebase Data Connect's generated + * GraphQL schema. GraphQL introspection query provides metadata such as what + * tables the schema have, what queries and mutations can be performed on the + * schema, and so on. Read more at https://graphql.org/learn/introspection. + * IntrospectGraphql can read schema metadata but cannot read rows from Cloud + * SQL instance, which can be done via ExecuteGraphqlRead. + * + * Method: firebasedataconnect.projects.locations.services.introspectGraphql + * + * Authorization scope(s): + * @c kGTLRAuthScopeFirebaseDataConnectCloudPlatform + */ +@interface GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesIntrospectGraphql : GTLRFirebaseDataConnectQuery + +/** + * Required. The relative resource name of Firebase Data Connect service, in + * the format: ``` projects/{project}/locations/{location}/services/{service} + * ``` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRFirebaseDataConnect_GraphqlResponse. + * + * Execute introspection query against the Firebase Data Connect's generated + * GraphQL schema. GraphQL introspection query provides metadata such as what + * tables the schema have, what queries and mutations can be performed on the + * schema, and so on. Read more at https://graphql.org/learn/introspection. + * IntrospectGraphql can read schema metadata but cannot read rows from Cloud + * SQL instance, which can be done via ExecuteGraphqlRead. + * + * @param object The @c GTLRFirebaseDataConnect_GraphqlRequest to include in + * the query. + * @param name Required. The relative resource name of Firebase Data Connect + * service, in the format: ``` + * projects/{project}/locations/{location}/services/{service} ``` + * + * @return GTLRFirebaseDataConnectQuery_ProjectsLocationsServicesIntrospectGraphql + */ ++ (instancetype)queryWithObject:(GTLRFirebaseDataConnect_GraphqlRequest *)object + name:(NSString *)name; + +@end + /** * Lists Services in a given project and location. * diff --git a/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingObjects.m b/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingObjects.m index 5b52d9a34..718ef6da9 100644 --- a/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingObjects.m +++ b/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingObjects.m @@ -174,11 +174,12 @@ @implementation GTLRFirebaseHosting_HttpUpdate // @implementation GTLRFirebaseHosting_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRFirebaseHosting_Operation class] + @"operations" : [GTLRFirebaseHosting_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingQuery.m b/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingQuery.m index 75d200e60..73b793f23 100644 --- a/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingQuery.m +++ b/Sources/GeneratedServices/FirebaseHosting/GTLRFirebaseHostingQuery.m @@ -67,7 +67,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRFirebaseHostingQuery_OperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingObjects.h b/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingObjects.h index 825ead0f2..b12c1afd3 100644 --- a/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingObjects.h +++ b/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingObjects.h @@ -692,6 +692,13 @@ FOUNDATION_EXTERN NSString * const kGTLRFirebaseHosting_LiveMigrationStep_State_ */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingQuery.h b/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingQuery.h index d4ab6e927..468021e87 100644 --- a/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingQuery.h +++ b/Sources/GeneratedServices/FirebaseHosting/Public/GoogleAPIClientForREST/GTLRFirebaseHostingQuery.h @@ -127,6 +127,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRFirebaseHosting_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLObjects.m b/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLObjects.m index 334ad0a8f..a8801f993 100644 --- a/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLObjects.m +++ b/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLObjects.m @@ -42,11 +42,12 @@ @implementation GTLRFirebaseML_Empty // @implementation GTLRFirebaseML_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRFirebaseML_Operation class] + @"operations" : [GTLRFirebaseML_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLQuery.m b/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLQuery.m index 2b5a67d40..7c72e355c 100644 --- a/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLQuery.m +++ b/Sources/GeneratedServices/FirebaseML/GTLRFirebaseMLQuery.m @@ -64,7 +64,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRFirebaseMLQuery_OperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLObjects.h b/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLObjects.h index ef5e932a8..6a72f7be5 100644 --- a/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLObjects.h +++ b/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLObjects.h @@ -90,6 +90,13 @@ FOUNDATION_EXTERN NSString * const kGTLRFirebaseML_ModelOperationMetadata_BasicO */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLQuery.h b/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLQuery.h index 9cadda3fb..36e189163 100644 --- a/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLQuery.h +++ b/Sources/GeneratedServices/FirebaseML/Public/GoogleAPIClientForREST/GTLRFirebaseMLQuery.h @@ -133,6 +133,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRFirebaseML_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Firestore/GTLRFirestoreObjects.m b/Sources/GeneratedServices/Firestore/GTLRFirestoreObjects.m index 00e5c24ef..5af71067b 100644 --- a/Sources/GeneratedServices/Firestore/GTLRFirestoreObjects.m +++ b/Sources/GeneratedServices/Firestore/GTLRFirestoreObjects.m @@ -89,11 +89,26 @@ NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_DeleteProtectionState_DeleteProtectionEnabled = @"DELETE_PROTECTION_ENABLED"; NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_DeleteProtectionState_DeleteProtectionStateUnspecified = @"DELETE_PROTECTION_STATE_UNSPECIFIED"; +// GTLRFirestore_GoogleFirestoreAdminV1Database.firestoreDataAccessMode +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeDisabled = @"DATA_ACCESS_MODE_DISABLED"; +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeEnabled = @"DATA_ACCESS_MODE_ENABLED"; +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeUnspecified = @"DATA_ACCESS_MODE_UNSPECIFIED"; + +// GTLRFirestore_GoogleFirestoreAdminV1Database.mongodbCompatibleDataAccessMode +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeDisabled = @"DATA_ACCESS_MODE_DISABLED"; +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeEnabled = @"DATA_ACCESS_MODE_ENABLED"; +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeUnspecified = @"DATA_ACCESS_MODE_UNSPECIFIED"; + // GTLRFirestore_GoogleFirestoreAdminV1Database.pointInTimeRecoveryEnablement NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_PointInTimeRecoveryEnablement_PointInTimeRecoveryDisabled = @"POINT_IN_TIME_RECOVERY_DISABLED"; NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_PointInTimeRecoveryEnablement_PointInTimeRecoveryEnabled = @"POINT_IN_TIME_RECOVERY_ENABLED"; NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_PointInTimeRecoveryEnablement_PointInTimeRecoveryEnablementUnspecified = @"POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED"; +// GTLRFirestore_GoogleFirestoreAdminV1Database.realtimeUpdatesMode +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesDisabled = @"REALTIME_UPDATES_DISABLED"; +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesEnabled = @"REALTIME_UPDATES_ENABLED"; +NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesModeUnspecified = @"REALTIME_UPDATES_MODE_UNSPECIFIED"; + // GTLRFirestore_GoogleFirestoreAdminV1Database.type NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_Type_DatabaseTypeUnspecified = @"DATABASE_TYPE_UNSPECIFIED"; NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_Type_DatastoreMode = @"DATASTORE_MODE"; @@ -914,9 +929,10 @@ @implementation GTLRFirestore_GoogleFirestoreAdminV1DailyRecurrence @implementation GTLRFirestore_GoogleFirestoreAdminV1Database @dynamic appEngineIntegrationMode, cmekConfig, concurrencyMode, createTime, databaseEdition, deleteProtectionState, deleteTime, - earliestVersionTime, ETag, freeTier, keyPrefix, locationId, name, - pointInTimeRecoveryEnablement, previousId, sourceInfo, tags, type, uid, - updateTime, versionRetentionPeriod; + earliestVersionTime, ETag, firestoreDataAccessMode, freeTier, + keyPrefix, locationId, mongodbCompatibleDataAccessMode, name, + pointInTimeRecoveryEnablement, previousId, realtimeUpdatesMode, + sourceInfo, tags, type, uid, updateTime, versionRetentionPeriod; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"ETag" : @"etag" }; diff --git a/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreObjects.h b/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreObjects.h index 766ef2b7c..2a6ca02c5 100644 --- a/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreObjects.h +++ b/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreObjects.h @@ -516,6 +516,50 @@ FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database */ FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_DeleteProtectionState_DeleteProtectionStateUnspecified; +// ---------------------------------------------------------------------------- +// GTLRFirestore_GoogleFirestoreAdminV1Database.firestoreDataAccessMode + +/** + * Accessing the database through the API is disallowed. + * + * Value: "DATA_ACCESS_MODE_DISABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeDisabled; +/** + * Accessing the database through the API is allowed. + * + * Value: "DATA_ACCESS_MODE_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeEnabled; +/** + * Not Used. + * + * Value: "DATA_ACCESS_MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRFirestore_GoogleFirestoreAdminV1Database.mongodbCompatibleDataAccessMode + +/** + * Accessing the database through the API is disallowed. + * + * Value: "DATA_ACCESS_MODE_DISABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeDisabled; +/** + * Accessing the database through the API is allowed. + * + * Value: "DATA_ACCESS_MODE_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeEnabled; +/** + * Not Used. + * + * Value: "DATA_ACCESS_MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeUnspecified; + // ---------------------------------------------------------------------------- // GTLRFirestore_GoogleFirestoreAdminV1Database.pointInTimeRecoveryEnablement @@ -542,6 +586,29 @@ FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database */ FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_PointInTimeRecoveryEnablement_PointInTimeRecoveryEnablementUnspecified; +// ---------------------------------------------------------------------------- +// GTLRFirestore_GoogleFirestoreAdminV1Database.realtimeUpdatesMode + +/** + * The Realtime Updates feature is disabled by default. + * + * Value: "REALTIME_UPDATES_DISABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesDisabled; +/** + * The Realtime Updates feature is enabled by default. This could potentially + * degrade write performance for the database. + * + * Value: "REALTIME_UPDATES_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesEnabled; +/** + * The Realtime Updates feature is not specified. + * + * Value: "REALTIME_UPDATES_MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesModeUnspecified; + // ---------------------------------------------------------------------------- // GTLRFirestore_GoogleFirestoreAdminV1Database.type @@ -2796,6 +2863,24 @@ FOUNDATION_EXTERN NSString * const kGTLRFirestore_Value_NullValue_NullValue; */ @property(nonatomic, copy, nullable) NSString *ETag; +/** + * Optional. The Firestore API data access mode to use for this database. If + * not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for + * Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for + * Standard Edition. + * + * Likely values: + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeDisabled + * Accessing the database through the API is disallowed. (Value: + * "DATA_ACCESS_MODE_DISABLED") + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeEnabled + * Accessing the database through the API is allowed. (Value: + * "DATA_ACCESS_MODE_ENABLED") + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_FirestoreDataAccessMode_DataAccessModeUnspecified + * Not Used. (Value: "DATA_ACCESS_MODE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *firestoreDataAccessMode; + /** * Output only. Background: Free tier is the ability of a Firestore database to * use a small amount of resources every day without being charged. Once usage @@ -2825,6 +2910,24 @@ FOUNDATION_EXTERN NSString * const kGTLRFirestore_Value_NullValue_NullValue; */ @property(nonatomic, copy, nullable) NSString *locationId; +/** + * Optional. The MongoDB compatible API data access mode to use for this + * database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED + * for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for + * Standard Edition. + * + * Likely values: + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeDisabled + * Accessing the database through the API is disallowed. (Value: + * "DATA_ACCESS_MODE_DISABLED") + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeEnabled + * Accessing the database through the API is allowed. (Value: + * "DATA_ACCESS_MODE_ENABLED") + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_MongodbCompatibleDataAccessMode_DataAccessModeUnspecified + * Not Used. (Value: "DATA_ACCESS_MODE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *mongodbCompatibleDataAccessMode; + /** * The resource name of the Database. Format: * `projects/{project}/databases/{database}` @@ -2856,6 +2959,23 @@ FOUNDATION_EXTERN NSString * const kGTLRFirestore_Value_NullValue_NullValue; */ @property(nonatomic, copy, nullable) NSString *previousId; +/** + * Immutable. The default Realtime Updates mode to use for this database. + * + * Likely values: + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesDisabled + * The Realtime Updates feature is disabled by default. (Value: + * "REALTIME_UPDATES_DISABLED") + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesEnabled + * The Realtime Updates feature is enabled by default. This could + * potentially degrade write performance for the database. (Value: + * "REALTIME_UPDATES_ENABLED") + * @arg @c kGTLRFirestore_GoogleFirestoreAdminV1Database_RealtimeUpdatesMode_RealtimeUpdatesModeUnspecified + * The Realtime Updates feature is not specified. (Value: + * "REALTIME_UPDATES_MODE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *realtimeUpdatesMode; + /** Output only. Information about the provenance of this database. */ @property(nonatomic, strong, nullable) GTLRFirestore_GoogleFirestoreAdminV1SourceInfo *sourceInfo; diff --git a/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreQuery.h b/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreQuery.h index 3eda71b53..367112d11 100644 --- a/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreQuery.h +++ b/Sources/GeneratedServices/Firestore/Public/GoogleAPIClientForREST/GTLRFirestoreQuery.h @@ -2343,8 +2343,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRFirestoreQuery_ProjectsLocationsList : GTLRFirestoreQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/GKEHub/GTLRGKEHubObjects.m b/Sources/GeneratedServices/GKEHub/GTLRGKEHubObjects.m index a79979e01..f24eeb8c8 100644 --- a/Sources/GeneratedServices/GKEHub/GTLRGKEHubObjects.m +++ b/Sources/GeneratedServices/GKEHub/GTLRGKEHubObjects.m @@ -1191,11 +1191,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRGKEHub_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRGKEHub_Operation class] + @"operations" : [GTLRGKEHub_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/GKEHub/GTLRGKEHubQuery.m b/Sources/GeneratedServices/GKEHub/GTLRGKEHubQuery.m index 019bdeda4..e40ca8726 100644 --- a/Sources/GeneratedServices/GKEHub/GTLRGKEHubQuery.m +++ b/Sources/GeneratedServices/GKEHub/GTLRGKEHubQuery.m @@ -218,7 +218,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRGKEHubQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubObjects.h b/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubObjects.h index e41cf6ff6..19d950c59 100644 --- a/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubObjects.h +++ b/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubObjects.h @@ -4172,6 +4172,13 @@ FOUNDATION_EXTERN NSString * const kGTLRGKEHub_WorkloadCertificateSpec_Certifica */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubQuery.h b/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubQuery.h index 3a1d5336f..5daf1eca6 100644 --- a/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubQuery.h +++ b/Sources/GeneratedServices/GKEHub/Public/GoogleAPIClientForREST/GTLRGKEHubQuery.h @@ -68,8 +68,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRGKEHubQuery_ProjectsLocationsList : GTLRGKEHubQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -432,6 +432,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRGKEHub_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/GKEOnPrem/Public/GoogleAPIClientForREST/GTLRGKEOnPremQuery.h b/Sources/GeneratedServices/GKEOnPrem/Public/GoogleAPIClientForREST/GTLRGKEOnPremQuery.h index 46d28293e..32eb29361 100644 --- a/Sources/GeneratedServices/GKEOnPrem/Public/GoogleAPIClientForREST/GTLRGKEOnPremQuery.h +++ b/Sources/GeneratedServices/GKEOnPrem/Public/GoogleAPIClientForREST/GTLRGKEOnPremQuery.h @@ -1884,8 +1884,8 @@ FOUNDATION_EXTERN NSString * const kGTLRGKEOnPremViewNodePoolViewUnspecified; @interface GTLRGKEOnPremQuery_ProjectsLocationsList : GTLRGKEOnPremQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/HangoutsChat/GTLRHangoutsChatObjects.m b/Sources/GeneratedServices/HangoutsChat/GTLRHangoutsChatObjects.m index 29af6d90c..d6c168fa0 100644 --- a/Sources/GeneratedServices/HangoutsChat/GTLRHangoutsChatObjects.m +++ b/Sources/GeneratedServices/HangoutsChat/GTLRHangoutsChatObjects.m @@ -181,6 +181,12 @@ NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DateTimePicker_Type_DateOnly = @"DATE_ONLY"; NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DateTimePicker_Type_TimeOnly = @"TIME_ONLY"; +// GTLRHangoutsChat_GoogleAppsCardV1DecoratedText.startIconVerticalAlignment +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Bottom = @"BOTTOM"; +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Middle = @"MIDDLE"; +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Top = @"TOP"; +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_VerticalAlignmentUnspecified = @"VERTICAL_ALIGNMENT_UNSPECIFIED"; + // GTLRHangoutsChat_GoogleAppsCardV1ExpressionDataCondition.conditionType NSString * const kGTLRHangoutsChat_GoogleAppsCardV1ExpressionDataCondition_ConditionType_ConditionTypeUnspecified = @"CONDITION_TYPE_UNSPECIFIED"; NSString * const kGTLRHangoutsChat_GoogleAppsCardV1ExpressionDataCondition_ConditionType_ExpressionEvaluationFailure = @"EXPRESSION_EVALUATION_FAILURE"; @@ -230,6 +236,11 @@ NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextInput_Type_MultipleLine = @"MULTIPLE_LINE"; NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextInput_Type_SingleLine = @"SINGLE_LINE"; +// GTLRHangoutsChat_GoogleAppsCardV1TextParagraph.textSyntax +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_Html = @"HTML"; +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_Markdown = @"MARKDOWN"; +NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_TextSyntaxUnspecified = @"TEXT_SYNTAX_UNSPECIFIED"; + // GTLRHangoutsChat_GoogleAppsCardV1UpdateVisibilityAction.visibility NSString * const kGTLRHangoutsChat_GoogleAppsCardV1UpdateVisibilityAction_Visibility_Hidden = @"HIDDEN"; NSString * const kGTLRHangoutsChat_GoogleAppsCardV1UpdateVisibilityAction_Visibility_VisibilityUnspecified = @"VISIBILITY_UNSPECIFIED"; @@ -1114,8 +1125,9 @@ @implementation GTLRHangoutsChat_GoogleAppsCardV1DateTimePicker // @implementation GTLRHangoutsChat_GoogleAppsCardV1DecoratedText -@dynamic bottomLabel, button, endIcon, icon, onClick, startIcon, switchControl, - text, topLabel, wrapText; +@dynamic bottomLabel, bottomLabelText, button, contentText, endIcon, icon, + onClick, startIcon, startIconVerticalAlignment, switchControl, text, + topLabel, topLabelText, wrapText; @end @@ -1439,7 +1451,7 @@ @implementation GTLRHangoutsChat_GoogleAppsCardV1TextInput // @implementation GTLRHangoutsChat_GoogleAppsCardV1TextParagraph -@dynamic maxLines, text; +@dynamic maxLines, text, textSyntax; @end diff --git a/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatObjects.h b/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatObjects.h index 63ae484fd..38cd63a7d 100644 --- a/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatObjects.h +++ b/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatObjects.h @@ -699,8 +699,9 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_DeprecatedEvent_DialogEvent */ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_DeprecatedEvent_Type_AddedToSpace; /** - * A user uses a Chat app [quick - * command](https://developers.google.com/workspace/chat/commands#types). + * A user uses a Chat app + * [command](https://developers.google.com/workspace/chat/commands#types), + * including slash commands and quick commands. * * Value: "APP_COMMAND" */ @@ -722,10 +723,10 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_DeprecatedEvent_Type_AppCom */ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_DeprecatedEvent_Type_CardClicked; /** - * A user sends the Chat app a message, or invokes the Chat app in a space, - * such as any of the following examples: * Any message in a direct message - * (DM) space with the Chat app. * A message in a multi-person space where a - * person \@mentions the Chat app, or uses one of its [slash + * A user sends the Chat app a message, or invokes the Chat app in a space. + * Examples of message events include: * Any message in a direct message (DM) + * space with the Chat app. * A message in a multi-person space where a person + * \@mentions the Chat app, or uses one of its [slash * commands](https://developers.google.com/workspace/chat/commands#types). * If * you've configured link previews for your Chat app, a user posts a message * that contains a link that matches the configured URL pattern. @@ -752,7 +753,8 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_DeprecatedEvent_Type_Remove */ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_DeprecatedEvent_Type_Unspecified; /** - * A user updates a widget in a card message or dialog. + * A user updates a widget in a card message or dialog. This event is triggered + * when a user interacts with a widget that has an associated action. * * Value: "WIDGET_UPDATED" */ @@ -1088,6 +1090,34 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DateTimePic */ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DateTimePicker_Type_TimeOnly; +// ---------------------------------------------------------------------------- +// GTLRHangoutsChat_GoogleAppsCardV1DecoratedText.startIconVerticalAlignment + +/** + * Alignment to the bottom position. + * + * Value: "BOTTOM" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Bottom; +/** + * Alignment to the middle position. + * + * Value: "MIDDLE" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Middle; +/** + * Alignment to the top position. + * + * Value: "TOP" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Top; +/** + * Unspecified type. Do not use. + * + * Value: "VERTICAL_ALIGNMENT_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_VerticalAlignmentUnspecified; + // ---------------------------------------------------------------------------- // GTLRHangoutsChat_GoogleAppsCardV1ExpressionDataCondition.conditionType @@ -1324,6 +1354,28 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextInput_T */ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextInput_Type_SingleLine; +// ---------------------------------------------------------------------------- +// GTLRHangoutsChat_GoogleAppsCardV1TextParagraph.textSyntax + +/** + * The text is rendered as HTML. This is the default value. + * + * Value: "HTML" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_Html; +/** + * The text is rendered as Markdown. + * + * Value: "MARKDOWN" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_Markdown; +/** + * The text is rendered as HTML if unspecified. + * + * Value: "TEXT_SYNTAX_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_TextSyntaxUnspecified; + // ---------------------------------------------------------------------------- // GTLRHangoutsChat_GoogleAppsCardV1UpdateVisibilityAction.visibility @@ -2820,8 +2872,11 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty @property(nonatomic, copy, nullable) NSString *hostApp; /** - * Name of the invoked function associated with the widget. Only set for Chat - * apps. + * Name of the function to invoke. This field doesn't populate for Google + * Workspace Add-ons that extend Google Chat. Instead, to receive function data + * like identifiers, add-ons that extend Chat should use the `parameters` + * field. See [Build interactive interfaces for Chat + * apps](https://developers.google.com/workspace/add-ons/chat/build). */ @property(nonatomic, copy, nullable) NSString *invokedFunction; @@ -3269,9 +3324,9 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty * apps in your domain](https://support.google.com/a/answer/172482). * (Value: "ADDED_TO_SPACE") * @arg @c kGTLRHangoutsChat_DeprecatedEvent_Type_AppCommand A user uses a - * Chat app [quick - * command](https://developers.google.com/workspace/chat/commands#types). - * (Value: "APP_COMMAND") + * Chat app + * [command](https://developers.google.com/workspace/chat/commands#types), + * including slash commands and quick commands. (Value: "APP_COMMAND") * @arg @c kGTLRHangoutsChat_DeprecatedEvent_Type_CardClicked A user clicks * an interactive element of a card or dialog from a Chat app, such as a * button. To receive an interaction event, the button must trigger @@ -3287,8 +3342,8 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty * [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType). * (Value: "CARD_CLICKED") * @arg @c kGTLRHangoutsChat_DeprecatedEvent_Type_Message A user sends the - * Chat app a message, or invokes the Chat app in a space, such as any of - * the following examples: * Any message in a direct message (DM) space + * Chat app a message, or invokes the Chat app in a space. Examples of + * message events include: * Any message in a direct message (DM) space * with the Chat app. * A message in a multi-person space where a person * \@mentions the Chat app, or uses one of its [slash * commands](https://developers.google.com/workspace/chat/commands#types). @@ -3307,8 +3362,9 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty * @arg @c kGTLRHangoutsChat_DeprecatedEvent_Type_Unspecified Default value * for the enum. DO NOT USE. (Value: "UNSPECIFIED") * @arg @c kGTLRHangoutsChat_DeprecatedEvent_Type_WidgetUpdated A user - * updates a widget in a card message or dialog. (Value: - * "WIDGET_UPDATED") + * updates a widget in a card message or dialog. This event is triggered + * when a user interacts with a widget that has an associated action. + * (Value: "WIDGET_UPDATED") */ @property(nonatomic, copy, nullable) NSString *type; @@ -3936,13 +3992,12 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** - * [Developer Preview](https://developers.google.com/workspace/preview): A - * carousel, also known as a slider, rotates and displays a list of widgets in - * a slideshow format, with buttons navigating to the previous or next widget. - * For example, this is a JSON representation of a carousel that contains three - * text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { - * "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { - * "widgets": [ { "textParagraph": { "text": "Second text paragraph in + * A carousel, also known as a slider, rotates and displays a list of widgets + * in a slideshow format, with buttons navigating to the previous or next + * widget. For example, this is a JSON representation of a carousel that + * contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": + * [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, + * { "widgets": [ { "textParagraph": { "text": "Second text paragraph in * carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text * paragraph in carousel", } } ] } ] } ``` [Google Chat * apps](https://developers.google.com/workspace/chat): @@ -3956,8 +4011,7 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** - * [Developer Preview](https://developers.google.com/workspace/preview): A card - * that can be displayed as a carousel item. [Google Chat + * A card that can be displayed as a carousel item. [Google Chat * apps](https://developers.google.com/workspace/chat): */ @interface GTLRHangoutsChat_GoogleAppsCardV1CarouselCard : GTLRObject @@ -4334,9 +4388,23 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** The text that appears below `text`. Always wraps. */ @property(nonatomic, copy, nullable) NSString *bottomLabel; +/** + * `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more + * complex formatting than `bottom_label`. [Google Chat + * apps](https://developers.google.com/workspace/chat): + */ +@property(nonatomic, strong, nullable) GTLRHangoutsChat_GoogleAppsCardV1TextParagraph *bottomLabelText; + /** A button that a user can click to trigger an action. */ @property(nonatomic, strong, nullable) GTLRHangoutsChat_GoogleAppsCardV1Button *button; +/** + * `TextParagraph` equivalent of `text`. Allows for more complex formatting + * than `text`. [Google Chat + * apps](https://developers.google.com/workspace/chat): + */ +@property(nonatomic, strong, nullable) GTLRHangoutsChat_GoogleAppsCardV1TextParagraph *contentText; + /** * An icon displayed after the text. Supports * [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) @@ -4355,6 +4423,24 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** The icon displayed in front of the text. */ @property(nonatomic, strong, nullable) GTLRHangoutsChat_GoogleAppsCardV1Icon *startIcon; +/** + * Optional. Vertical alignment of the start icon. If not set, the icon will be + * vertically centered. [Google Chat + * apps](https://developers.google.com/workspace/chat): + * + * Likely values: + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Bottom + * Alignment to the bottom position. (Value: "BOTTOM") + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Middle + * Alignment to the middle position. (Value: "MIDDLE") + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_Top + * Alignment to the top position. (Value: "TOP") + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1DecoratedText_StartIconVerticalAlignment_VerticalAlignmentUnspecified + * Unspecified type. Do not use. (Value: + * "VERTICAL_ALIGNMENT_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *startIconVerticalAlignment; + /** * A switch widget that a user can click to change its state and trigger an * action. @@ -4373,6 +4459,13 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** The text that appears above `text`. Always truncates. */ @property(nonatomic, copy, nullable) NSString *topLabel; +/** + * `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more + * complex formatting than `top_label`. [Google Chat + * apps](https://developers.google.com/workspace/chat): + */ +@property(nonatomic, strong, nullable) GTLRHangoutsChat_GoogleAppsCardV1TextParagraph *topLabelText; + /** * The wrap text setting. If `true`, the text wraps and displays on multiple * lines. Otherwise, the text is truncated. Only applies to `text`, not @@ -4776,8 +4869,7 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** - * [Developer Preview](https://developers.google.com/workspace/preview): A list - * of widgets that can be displayed in a containing layout, such as a + * A list of widgets that can be displayed in a containing layout, such as a * `CarouselCard`. [Google Chat * apps](https://developers.google.com/workspace/chat): */ @@ -5445,6 +5537,22 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty /** The text that's shown in the widget. */ @property(nonatomic, copy, nullable) NSString *text; +/** + * The syntax of the text. If not set, the text is rendered as HTML. [Google + * Chat apps](https://developers.google.com/workspace/chat): + * + * Likely values: + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_Html + * The text is rendered as HTML. This is the default value. (Value: + * "HTML") + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_Markdown + * The text is rendered as Markdown. (Value: "MARKDOWN") + * @arg @c kGTLRHangoutsChat_GoogleAppsCardV1TextParagraph_TextSyntax_TextSyntaxUnspecified + * The text is rendered as HTML if unspecified. (Value: + * "TEXT_SYNTAX_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *textSyntax; + @end @@ -6703,8 +6811,8 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChat_WorkflowDataSourceMarkup_Ty @interface GTLRHangoutsChat_MessageDeletedEventData : GTLRObject /** - * The deleted message. Only the `name`, `createTime`, `deleteTime`, and - * `deletionMetadata` fields are populated. + * The deleted message. Only the `name`, `createTime`, and `deletionMetadata` + * fields are populated. */ @property(nonatomic, strong, nullable) GTLRHangoutsChat_Message *message; diff --git a/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatQuery.h b/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatQuery.h index fff3a142e..a9d5de152 100644 --- a/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatQuery.h +++ b/Sources/GeneratedServices/HangoutsChat/Public/GoogleAPIClientForREST/GTLRHangoutsChatQuery.h @@ -2718,11 +2718,21 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * if you request an event about a new message but the message was later * updated, the server returns the updated `Message` resource in the event * payload. Note: The `permissionSettings` field is not returned in the Space - * object of the Space event data for this request. Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * object of the Space event data for this request. Supports the following + * types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) * with an [authorization * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) - * appropriate for reading the requested data: - + * appropriate for reading the requested data: - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) with + * one of the following authorization scopes: - + * `https://www.googleapis.com/auth/chat.app.spaces` - + * `https://www.googleapis.com/auth/chat.app.messages.readonly` - + * `https://www.googleapis.com/auth/chat.app.memberships` - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * with one of the following authorization scopes: - * `https://www.googleapis.com/auth/chat.spaces.readonly` - * `https://www.googleapis.com/auth/chat.spaces` - * `https://www.googleapis.com/auth/chat.messages.readonly` - @@ -2731,7 +2741,7 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * `https://www.googleapis.com/auth/chat.messages.reactions` - * `https://www.googleapis.com/auth/chat.memberships.readonly` - * `https://www.googleapis.com/auth/chat.memberships` To get an event, the - * authenticated user must be a member of the space. For an example, see [Get + * authenticated caller must be a member of the space. For an example, see [Get * details about an event from a Google Chat * space](https://developers.google.com/workspace/chat/get-space-event). * @@ -2766,11 +2776,21 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * if you request an event about a new message but the message was later * updated, the server returns the updated `Message` resource in the event * payload. Note: The `permissionSettings` field is not returned in the Space - * object of the Space event data for this request. Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * object of the Space event data for this request. Supports the following + * types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) * with an [authorization * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) - * appropriate for reading the requested data: - + * appropriate for reading the requested data: - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) with + * one of the following authorization scopes: - + * `https://www.googleapis.com/auth/chat.app.spaces` - + * `https://www.googleapis.com/auth/chat.app.messages.readonly` - + * `https://www.googleapis.com/auth/chat.app.memberships` - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * with one of the following authorization scopes: - * `https://www.googleapis.com/auth/chat.spaces.readonly` - * `https://www.googleapis.com/auth/chat.spaces` - * `https://www.googleapis.com/auth/chat.messages.readonly` - @@ -2779,7 +2799,7 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * `https://www.googleapis.com/auth/chat.messages.reactions` - * `https://www.googleapis.com/auth/chat.memberships.readonly` - * `https://www.googleapis.com/auth/chat.memberships` To get an event, the - * authenticated user must be a member of the space. For an example, see [Get + * authenticated caller must be a member of the space. For an example, see [Get * details about an event from a Google Chat * space](https://developers.google.com/workspace/chat/get-space-event). * @@ -2799,11 +2819,20 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * list events about new space members, the server returns `Membership` * resources that contain the latest membership details. If new members were * removed during the requested period, the event payload contains an empty - * `Membership` resource. Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * `Membership` resource. Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) * with an [authorization * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) - * appropriate for reading the requested data: - + * appropriate for reading the requested data: - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) with + * one of the following authorization scopes: - + * `https://www.googleapis.com/auth/chat.app.spaces` - + * `https://www.googleapis.com/auth/chat.app.messages.readonly` - + * `https://www.googleapis.com/auth/chat.app.memberships` - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * with one of the following authorization scopes: - * `https://www.googleapis.com/auth/chat.spaces.readonly` - * `https://www.googleapis.com/auth/chat.spaces` - * `https://www.googleapis.com/auth/chat.messages.readonly` - @@ -2812,8 +2841,8 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * `https://www.googleapis.com/auth/chat.messages.reactions` - * `https://www.googleapis.com/auth/chat.memberships.readonly` - * `https://www.googleapis.com/auth/chat.memberships` To list events, the - * authenticated user must be a member of the space. For an example, see [List - * events from a Google Chat + * authenticated caller must be a member of the space. For an example, see + * [List events from a Google Chat * space](https://developers.google.com/workspace/chat/list-space-events). * * Method: chat.spaces.spaceEvents.list @@ -2896,11 +2925,20 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * list events about new space members, the server returns `Membership` * resources that contain the latest membership details. If new members were * removed during the requested period, the event payload contains an empty - * `Membership` resource. Requires [user - * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * `Membership` resource. Supports the following types of + * [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) * with an [authorization * scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) - * appropriate for reading the requested data: - + * appropriate for reading the requested data: - [App + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) + * with [administrator approval](https://support.google.com/a?p=chat-app-auth) + * in [Developer Preview](https://developers.google.com/workspace/preview) with + * one of the following authorization scopes: - + * `https://www.googleapis.com/auth/chat.app.spaces` - + * `https://www.googleapis.com/auth/chat.app.messages.readonly` - + * `https://www.googleapis.com/auth/chat.app.memberships` - [User + * authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * with one of the following authorization scopes: - * `https://www.googleapis.com/auth/chat.spaces.readonly` - * `https://www.googleapis.com/auth/chat.spaces` - * `https://www.googleapis.com/auth/chat.messages.readonly` - @@ -2909,8 +2947,8 @@ FOUNDATION_EXTERN NSString * const kGTLRHangoutsChatMessageReplyOptionReplyMessa * `https://www.googleapis.com/auth/chat.messages.reactions` - * `https://www.googleapis.com/auth/chat.memberships.readonly` - * `https://www.googleapis.com/auth/chat.memberships` To list events, the - * authenticated user must be a member of the space. For an example, see [List - * events from a Google Chat + * authenticated caller must be a member of the space. For an example, see + * [List events from a Google Chat * space](https://developers.google.com/workspace/chat/list-space-events). * * @param parent Required. Resource name of the [Google Chat diff --git a/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingObjects.h b/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingObjects.h index ceadae444..6c1b51346 100644 --- a/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingObjects.h +++ b/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingObjects.h @@ -3338,8 +3338,9 @@ FOUNDATION_EXTERN NSString * const kGTLRLogging_SuppressionInfo_Reason_ReasonUns @property(nonatomic, copy, nullable) NSString *name; /** - * Required. Names of one or more parent resources: projects/[PROJECT_ID]May - * alternatively be one or more views: + * Required. Names of one or more parent resources (organizations and folders + * are not supported.): projects/[PROJECT_ID]May alternatively be one or more + * views: * projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A * log scope can include a maximum of 5 projects and a maximum of 100 resources * in total. diff --git a/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingQuery.h b/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingQuery.h index d0e46531b..18f57dfc6 100644 --- a/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingQuery.h +++ b/Sources/GeneratedServices/Logging/Public/GoogleAPIClientForREST/GTLRLoggingQuery.h @@ -1281,8 +1281,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRLoggingQuery_BillingAccountsLocationsList : GTLRLoggingQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -4018,8 +4018,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRLoggingQuery_FoldersLocationsList : GTLRLoggingQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -4081,8 +4081,10 @@ NS_ASSUME_NONNULL_BEGIN @property(nonatomic, copy, nullable) NSString *logScopeId; /** - * Required. The parent project in which to create the log scope - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For + * Required. The parent resource in which to create the log scope: + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global" */ @property(nonatomic, copy, nullable) NSString *parent; @@ -4093,8 +4095,10 @@ NS_ASSUME_NONNULL_BEGIN * Creates a log scope. * * @param object The @c GTLRLogging_LogScope to include in the query. - * @param parent Required. The parent project in which to create the log scope - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For + * @param parent Required. The parent resource in which to create the log + * scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global" * * @return GTLRLoggingQuery_FoldersLocationsLogScopesCreate @@ -4117,7 +4121,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Required. The resource name of the log scope to delete: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global/logScopes/my-log-scope" */ @property(nonatomic, copy, nullable) NSString *name; @@ -4128,8 +4134,10 @@ NS_ASSUME_NONNULL_BEGIN * Deletes a log scope. * * @param name Required. The resource name of the log scope to delete: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" - * For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For + * example:"projects/my-project/locations/global/logScopes/my-log-scope" * * @return GTLRLoggingQuery_FoldersLocationsLogScopesDelete */ @@ -4152,7 +4160,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Required. The resource name of the log scope: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global/logScopes/my-log-scope" */ @property(nonatomic, copy, nullable) NSString *name; @@ -4163,8 +4173,10 @@ NS_ASSUME_NONNULL_BEGIN * Gets a log scope. * * @param name Required. The resource name of the log scope: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" - * For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For + * example:"projects/my-project/locations/global/logScopes/my-log-scope" * * @return GTLRLoggingQuery_FoldersLocationsLogScopesGet */ @@ -6274,8 +6286,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRLoggingQuery_LocationsList : GTLRLoggingQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -7975,8 +7987,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRLoggingQuery_OrganizationsLocationsList : GTLRLoggingQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -8038,8 +8050,10 @@ NS_ASSUME_NONNULL_BEGIN @property(nonatomic, copy, nullable) NSString *logScopeId; /** - * Required. The parent project in which to create the log scope - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For + * Required. The parent resource in which to create the log scope: + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global" */ @property(nonatomic, copy, nullable) NSString *parent; @@ -8050,8 +8064,10 @@ NS_ASSUME_NONNULL_BEGIN * Creates a log scope. * * @param object The @c GTLRLogging_LogScope to include in the query. - * @param parent Required. The parent project in which to create the log scope - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For + * @param parent Required. The parent resource in which to create the log + * scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global" * * @return GTLRLoggingQuery_OrganizationsLocationsLogScopesCreate @@ -8074,7 +8090,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Required. The resource name of the log scope to delete: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global/logScopes/my-log-scope" */ @property(nonatomic, copy, nullable) NSString *name; @@ -8085,8 +8103,10 @@ NS_ASSUME_NONNULL_BEGIN * Deletes a log scope. * * @param name Required. The resource name of the log scope to delete: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" - * For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For + * example:"projects/my-project/locations/global/logScopes/my-log-scope" * * @return GTLRLoggingQuery_OrganizationsLocationsLogScopesDelete */ @@ -8109,7 +8129,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Required. The resource name of the log scope: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global/logScopes/my-log-scope" */ @property(nonatomic, copy, nullable) NSString *name; @@ -8120,8 +8142,10 @@ NS_ASSUME_NONNULL_BEGIN * Gets a log scope. * * @param name Required. The resource name of the log scope: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" - * For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For + * example:"projects/my-project/locations/global/logScopes/my-log-scope" * * @return GTLRLoggingQuery_OrganizationsLocationsLogScopesGet */ @@ -10710,8 +10734,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRLoggingQuery_ProjectsLocationsList : GTLRLoggingQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -10773,8 +10797,10 @@ NS_ASSUME_NONNULL_BEGIN @property(nonatomic, copy, nullable) NSString *logScopeId; /** - * Required. The parent project in which to create the log scope - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For + * Required. The parent resource in which to create the log scope: + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global" */ @property(nonatomic, copy, nullable) NSString *parent; @@ -10785,8 +10811,10 @@ NS_ASSUME_NONNULL_BEGIN * Creates a log scope. * * @param object The @c GTLRLogging_LogScope to include in the query. - * @param parent Required. The parent project in which to create the log scope - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For + * @param parent Required. The parent resource in which to create the log + * scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global" * * @return GTLRLoggingQuery_ProjectsLocationsLogScopesCreate @@ -10809,7 +10837,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Required. The resource name of the log scope to delete: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global/logScopes/my-log-scope" */ @property(nonatomic, copy, nullable) NSString *name; @@ -10820,8 +10850,10 @@ NS_ASSUME_NONNULL_BEGIN * Deletes a log scope. * * @param name Required. The resource name of the log scope to delete: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" - * For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For + * example:"projects/my-project/locations/global/logScopes/my-log-scope" * * @return GTLRLoggingQuery_ProjectsLocationsLogScopesDelete */ @@ -10844,7 +10876,9 @@ NS_ASSUME_NONNULL_BEGIN /** * Required. The resource name of the log scope: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For * example:"projects/my-project/locations/global/logScopes/my-log-scope" */ @property(nonatomic, copy, nullable) NSString *name; @@ -10855,8 +10889,10 @@ NS_ASSUME_NONNULL_BEGIN * Gets a log scope. * * @param name Required. The resource name of the log scope: - * "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" - * For example:"projects/my-project/locations/global/logScopes/my-log-scope" + * "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + * "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" + * "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For + * example:"projects/my-project/locations/global/logScopes/my-log-scope" * * @return GTLRLoggingQuery_ProjectsLocationsLogScopesGet */ diff --git a/Sources/GeneratedServices/Looker/Public/GoogleAPIClientForREST/GTLRLookerQuery.h b/Sources/GeneratedServices/Looker/Public/GoogleAPIClientForREST/GTLRLookerQuery.h index 944b45977..27253fd58 100644 --- a/Sources/GeneratedServices/Looker/Public/GoogleAPIClientForREST/GTLRLookerQuery.h +++ b/Sources/GeneratedServices/Looker/Public/GoogleAPIClientForREST/GTLRLookerQuery.h @@ -515,8 +515,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRLookerQuery_ProjectsLocationsList : GTLRLookerQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/ManagedKafka/Public/GoogleAPIClientForREST/GTLRManagedKafkaQuery.h b/Sources/GeneratedServices/ManagedKafka/Public/GoogleAPIClientForREST/GTLRManagedKafkaQuery.h index ffa5eca8f..674603e9c 100644 --- a/Sources/GeneratedServices/ManagedKafka/Public/GoogleAPIClientForREST/GTLRManagedKafkaQuery.h +++ b/Sources/GeneratedServices/ManagedKafka/Public/GoogleAPIClientForREST/GTLRManagedKafkaQuery.h @@ -1575,8 +1575,8 @@ FOUNDATION_EXTERN NSString * const kGTLRManagedKafkaViewSchemaRegistryViewUnspec @interface GTLRManagedKafkaQuery_ProjectsLocationsList : GTLRManagedKafkaQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/MapsPlaces/GTLRMapsPlacesObjects.m b/Sources/GeneratedServices/MapsPlaces/GTLRMapsPlacesObjects.m index 3d6b79e91..fadd90bf6 100644 --- a/Sources/GeneratedServices/MapsPlaces/GTLRMapsPlacesObjects.m +++ b/Sources/GeneratedServices/MapsPlaces/GTLRMapsPlacesObjects.m @@ -540,7 +540,7 @@ @implementation GTLRMapsPlaces_GoogleMapsPlacesV1PhotoMedia @implementation GTLRMapsPlaces_GoogleMapsPlacesV1Place @dynamic accessibilityOptions, addressComponents, addressDescriptor, adrFormatAddress, allowsDogs, attributions, businessStatus, - containingPlaces, curbsidePickup, currentOpeningHours, + consumerAlert, containingPlaces, curbsidePickup, currentOpeningHours, currentSecondaryOpeningHours, delivery, dineIn, displayName, editorialSummary, evChargeAmenitySummary, evChargeOptions, formattedAddress, fuelOptions, generativeSummary, goodForChildren, @@ -619,6 +619,41 @@ @implementation GTLRMapsPlaces_GoogleMapsPlacesV1PlaceAttribution @end +// ---------------------------------------------------------------------------- +// +// GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlert +// + +@implementation GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlert +@dynamic details, languageCode, overview; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetails +// + +@implementation GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetails +@dynamic aboutLink, descriptionProperty, title; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink +// + +@implementation GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink +@dynamic title, uri; +@end + + // ---------------------------------------------------------------------------- // // GTLRMapsPlaces_GoogleMapsPlacesV1PlaceContainingPlace @@ -813,7 +848,7 @@ @implementation GTLRMapsPlaces_GoogleMapsPlacesV1PriceRange @implementation GTLRMapsPlaces_GoogleMapsPlacesV1Review @dynamic authorAttribution, flagContentUri, googleMapsUri, name, originalText, - publishTime, rating, relativePublishTimeDescription, text; + publishTime, rating, relativePublishTimeDescription, text, visitDate; @end diff --git a/Sources/GeneratedServices/MapsPlaces/Public/GoogleAPIClientForREST/GTLRMapsPlacesObjects.h b/Sources/GeneratedServices/MapsPlaces/Public/GoogleAPIClientForREST/GTLRMapsPlacesObjects.h index 3b1a58c38..0499fdad1 100644 --- a/Sources/GeneratedServices/MapsPlaces/Public/GoogleAPIClientForREST/GTLRMapsPlacesObjects.h +++ b/Sources/GeneratedServices/MapsPlaces/Public/GoogleAPIClientForREST/GTLRMapsPlacesObjects.h @@ -42,6 +42,9 @@ @class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceAccessibilityOptions; @class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceAddressComponent; @class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceAttribution; +@class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlert; +@class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetails; +@class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink; @class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceContainingPlace; @class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceEvChargeAmenitySummary; @class GTLRMapsPlaces_GoogleMapsPlacesV1PlaceGenerativeSummary; @@ -1761,6 +1764,12 @@ FOUNDATION_EXTERN NSString * const kGTLRMapsPlaces_GoogleMapsPlacesV1SearchTextR */ @property(nonatomic, copy, nullable) NSString *businessStatus; +/** + * The consumer alert message for the place when we detect suspicious review + * activity on a business or a business violates our policies. + */ +@property(nonatomic, strong, nullable) GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlert *consumerAlert; + /** List of places in which the current place is located. */ @property(nonatomic, strong, nullable) NSArray *containingPlaces; @@ -2258,6 +2267,64 @@ FOUNDATION_EXTERN NSString * const kGTLRMapsPlaces_GoogleMapsPlacesV1SearchTextR @end +/** + * The consumer alert message for the place when we detect suspicious review + * activity on a business or a business violates our policies. + */ +@interface GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlert : GTLRObject + +/** The details of the consumer alert message.ƒ */ +@property(nonatomic, strong, nullable) GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetails *details; + +/** + * The language code of the consumer alert message. This is a BCP 47 language + * code. + */ +@property(nonatomic, copy, nullable) NSString *languageCode; + +/** The overview of the consumer alert message. */ +@property(nonatomic, copy, nullable) NSString *overview; + +@end + + +/** + * The details of the consumer alert message. + */ +@interface GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetails : GTLRObject + +/** + * The link to show together with the description to provide more information. + */ +@property(nonatomic, strong, nullable) GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink *aboutLink; + +/** + * The description of the consumer alert message. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** The title to show together with the description. */ +@property(nonatomic, copy, nullable) NSString *title; + +@end + + +/** + * The link to show together with the description to provide more information. + */ +@interface GTLRMapsPlaces_GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink : GTLRObject + +/** The title to show for the link. */ +@property(nonatomic, copy, nullable) NSString *title; + +/** The uri of the link. */ +@property(nonatomic, copy, nullable) NSString *uri; + +@end + + /** * Info about the place in which this place is located. */ @@ -2812,6 +2879,12 @@ FOUNDATION_EXTERN NSString * const kGTLRMapsPlaces_GoogleMapsPlacesV1SearchTextR /** The localized text of the review. */ @property(nonatomic, strong, nullable) GTLRMapsPlaces_GoogleTypeLocalizedText *text; +/** + * The date when the author visited the place. This is trucated to the year and + * month of the visit. + */ +@property(nonatomic, strong, nullable) GTLRMapsPlaces_GoogleTypeDate *visitDate; + @end diff --git a/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIObjects.m b/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIObjects.m index 45556c790..c5be18491 100644 --- a/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIObjects.m +++ b/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIObjects.m @@ -1687,11 +1687,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRMigrationCenterAPI_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRMigrationCenterAPI_Operation class] + @"operations" : [GTLRMigrationCenterAPI_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIQuery.m b/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIQuery.m index 5d53ab3dd..c556b4feb 100644 --- a/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIQuery.m +++ b/Sources/GeneratedServices/MigrationCenterAPI/GTLRMigrationCenterAPIQuery.m @@ -917,7 +917,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRMigrationCenterAPIQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIObjects.h b/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIObjects.h index c1553048a..74a65557d 100644 --- a/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIObjects.h +++ b/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIObjects.h @@ -3991,6 +3991,13 @@ FOUNDATION_EXTERN NSString * const kGTLRMigrationCenterAPI_VmwarePlatformDetails */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIQuery.h b/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIQuery.h index 1fa5c0ba9..8b5ed362d 100644 --- a/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIQuery.h +++ b/Sources/GeneratedServices/MigrationCenterAPI/Public/GoogleAPIClientForREST/GTLRMigrationCenterAPIQuery.h @@ -1736,6 +1736,17 @@ FOUNDATION_EXTERN NSString * const kGTLRMigrationCenterAPIViewReportViewUnspecif /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRMigrationCenterAPI_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesObjects.m b/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesObjects.m index 223698be9..4e265dabc 100644 --- a/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesObjects.m +++ b/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesObjects.m @@ -60,6 +60,13 @@ NSString * const kGTLRNetAppFiles_BackupVault_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLRNetAppFiles_BackupVault_State_Updating = @"UPDATING"; +// GTLRNetAppFiles_CacheParameters.cacheState +NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_CacheStateUnspecified = @"CACHE_STATE_UNSPECIFIED"; +NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_Error = @"ERROR"; +NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_Peered = @"PEERED"; +NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_PendingClusterPeering = @"PENDING_CLUSTER_PEERING"; +NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_PendingSvmPeering = @"PENDING_SVM_PEERING"; + // GTLRNetAppFiles_HybridReplicationParameters.hybridReplicationType NSString * const kGTLRNetAppFiles_HybridReplicationParameters_HybridReplicationType_ContinuousReplication = @"CONTINUOUS_REPLICATION"; NSString * const kGTLRNetAppFiles_HybridReplicationParameters_HybridReplicationType_Migration = @"MIGRATION"; @@ -433,6 +440,36 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRNetAppFiles_CacheConfig +// + +@implementation GTLRNetAppFiles_CacheConfig +@dynamic cifsChangeNotifyEnabled; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRNetAppFiles_CacheParameters +// + +@implementation GTLRNetAppFiles_CacheParameters +@dynamic cacheConfig, cacheState, command, enableGlobalFileLock, passphrase, + peerClusterName, peeringCommandExpiryTime, peerIpAddresses, + peerSvmName, peerVolumeName, stateDetails; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"peerIpAddresses" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRNetAppFiles_CancelOperationRequest @@ -1078,6 +1115,24 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRNetAppFiles_RestoreBackupFilesRequest +// + +@implementation GTLRNetAppFiles_RestoreBackupFilesRequest +@dynamic backup, fileList, restoreDestinationPath; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"fileList" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRNetAppFiles_RestoreParameters @@ -1344,15 +1399,16 @@ @implementation GTLRNetAppFiles_VerifyKmsConfigResponse // @implementation GTLRNetAppFiles_Volume -@dynamic activeDirectory, backupConfig, capacityGib, coldTierSizeGib, - createTime, descriptionProperty, encryptionType, exportPolicy, - hasReplication, hotTierSizeUsedGib, hybridReplicationParameters, - kerberosEnabled, kmsConfig, labels, largeCapacity, ldapEnabled, - mountOptions, multipleEndpoints, name, network, protocols, psaRange, - replicaZone, restoreParameters, restrictedActions, securityStyle, - serviceLevel, shareName, smbSettings, snapReserve, snapshotDirectory, - snapshotPolicy, state, stateDetails, storagePool, throughputMibps, - tieringPolicy, unixPermissions, usedGib, zoneProperty; +@dynamic activeDirectory, backupConfig, cacheParameters, capacityGib, + coldTierSizeGib, createTime, descriptionProperty, encryptionType, + exportPolicy, hasReplication, hotTierSizeUsedGib, + hybridReplicationParameters, kerberosEnabled, kmsConfig, labels, + largeCapacity, ldapEnabled, mountOptions, multipleEndpoints, name, + network, protocols, psaRange, replicaZone, restoreParameters, + restrictedActions, securityStyle, serviceLevel, shareName, smbSettings, + snapReserve, snapshotDirectory, snapshotPolicy, state, stateDetails, + storagePool, throughputMibps, tieringPolicy, unixPermissions, usedGib, + zoneProperty; + (NSDictionary *)propertyToJSONKeyMap { NSDictionary *map = @{ diff --git a/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesQuery.m b/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesQuery.m index a3e1c5064..4a1ab6a7c 100644 --- a/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesQuery.m +++ b/Sources/GeneratedServices/NetAppFiles/GTLRNetAppFilesQuery.m @@ -1389,6 +1389,33 @@ + (instancetype)queryWithObject:(GTLRNetAppFiles_SyncReplicationRequest *)object @end +@implementation GTLRNetAppFilesQuery_ProjectsLocationsVolumesRestore + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLRNetAppFiles_RestoreBackupFilesRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:restore"; + GTLRNetAppFilesQuery_ProjectsLocationsVolumesRestore *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRNetAppFiles_Operation class]; + query.loggingName = @"netapp.projects.locations.volumes.restore"; + return query; +} + +@end + @implementation GTLRNetAppFilesQuery_ProjectsLocationsVolumesRevert @dynamic name; diff --git a/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesObjects.h b/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesObjects.h index 52337c38e..711136067 100644 --- a/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesObjects.h +++ b/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesObjects.h @@ -26,6 +26,8 @@ @class GTLRNetAppFiles_BackupRetentionPolicy; @class GTLRNetAppFiles_BackupVault; @class GTLRNetAppFiles_BackupVault_Labels; +@class GTLRNetAppFiles_CacheConfig; +@class GTLRNetAppFiles_CacheParameters; @class GTLRNetAppFiles_DailySchedule; @class GTLRNetAppFiles_DestinationVolumeParameters; @class GTLRNetAppFiles_ExportPolicy; @@ -299,6 +301,42 @@ FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_BackupVault_State_StateUnspe */ FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_BackupVault_State_Updating; +// ---------------------------------------------------------------------------- +// GTLRNetAppFiles_CacheParameters.cacheState + +/** + * Default unspecified state. + * + * Value: "CACHE_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_CacheStateUnspecified; +/** + * Terminal state wherein peering with origin volume's ONTAP cluster has + * failed. + * + * Value: "ERROR" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_Error; +/** + * State indicating successful establishment of peering with origin volumes's + * ONTAP cluster. + * + * Value: "PEERED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_Peered; +/** + * State indicating waiting for cluster peering to be established. + * + * Value: "PENDING_CLUSTER_PEERING" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_PendingClusterPeering; +/** + * State indicating waiting for SVM peering to be established. + * + * Value: "PENDING_SVM_PEERING" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_CacheParameters_CacheState_PendingSvmPeering; + // ---------------------------------------------------------------------------- // GTLRNetAppFiles_HybridReplicationParameters.hybridReplicationType @@ -1897,6 +1935,96 @@ FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_Volume_State_Updating; @end +/** + * Configuration of the cache volume. + */ +@interface GTLRNetAppFiles_CacheConfig : GTLRObject + +/** + * Optional. Flag indicating whether a CIFS change notification is enabled for + * the FlexCache volume. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *cifsChangeNotifyEnabled; + +@end + + +/** + * Cache Parameters for the volume. + */ +@interface GTLRNetAppFiles_CacheParameters : GTLRObject + +/** Optional. Configuration of the cache volume. */ +@property(nonatomic, strong, nullable) GTLRNetAppFiles_CacheConfig *cacheConfig; + +/** + * Output only. State of the cache volume indicating the peering status. + * + * Likely values: + * @arg @c kGTLRNetAppFiles_CacheParameters_CacheState_CacheStateUnspecified + * Default unspecified state. (Value: "CACHE_STATE_UNSPECIFIED") + * @arg @c kGTLRNetAppFiles_CacheParameters_CacheState_Error Terminal state + * wherein peering with origin volume's ONTAP cluster has failed. (Value: + * "ERROR") + * @arg @c kGTLRNetAppFiles_CacheParameters_CacheState_Peered State + * indicating successful establishment of peering with origin volumes's + * ONTAP cluster. (Value: "PEERED") + * @arg @c kGTLRNetAppFiles_CacheParameters_CacheState_PendingClusterPeering + * State indicating waiting for cluster peering to be established. + * (Value: "PENDING_CLUSTER_PEERING") + * @arg @c kGTLRNetAppFiles_CacheParameters_CacheState_PendingSvmPeering + * State indicating waiting for SVM peering to be established. (Value: + * "PENDING_SVM_PEERING") + */ +@property(nonatomic, copy, nullable) NSString *cacheState; + +/** + * Output only. Copy-paste-able commands to be used on user's ONTAP to accept + * peering requests. + */ +@property(nonatomic, copy, nullable) NSString *command; + +/** + * Optional. Field indicating whether cache volume as global file lock enabled. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enableGlobalFileLock; + +/** + * Output only. Temporary passphrase generated to accept cluster peering + * command. + */ +@property(nonatomic, copy, nullable) NSString *passphrase; + +/** Required. Name of the origin volume's ONTAP cluster. */ +@property(nonatomic, copy, nullable) NSString *peerClusterName; + +/** + * Optional. Expiration time for the peering command to be executed on user's + * ONTAP. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *peeringCommandExpiryTime; + +/** + * Required. List of IC LIF addresses of the origin volume's ONTAP cluster. + */ +@property(nonatomic, strong, nullable) NSArray *peerIpAddresses; + +/** Required. Name of the origin volume's SVM. */ +@property(nonatomic, copy, nullable) NSString *peerSvmName; + +/** Required. Name of the origin volume for the cache volume. */ +@property(nonatomic, copy, nullable) NSString *peerVolumeName; + +/** Output only. Detailed description of the current cache state. */ +@property(nonatomic, copy, nullable) NSString *stateDetails; + +@end + + /** * The request message for Operations.CancelOperation. */ @@ -3181,6 +3309,29 @@ FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_Volume_State_Updating; @end +/** + * RestoreBackupFilesRequest restores files from a backup to a volume. + */ +@interface GTLRNetAppFiles_RestoreBackupFilesRequest : GTLRObject + +/** + * Required. The backup resource name, in the format + * `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}` + */ +@property(nonatomic, copy, nullable) NSString *backup; + +/** + * Required. List of files to be restored in the form of their absolute path as + * in source volume. + */ +@property(nonatomic, strong, nullable) NSArray *fileList; + +/** Optional. Absolute directory path in the destination volume. */ +@property(nonatomic, copy, nullable) NSString *restoreDestinationPath; + +@end + + /** * The RestoreParameters if volume is created from a snapshot or backup. */ @@ -3960,6 +4111,9 @@ FOUNDATION_EXTERN NSString * const kGTLRNetAppFiles_Volume_State_Updating; /** BackupConfig of the volume. */ @property(nonatomic, strong, nullable) GTLRNetAppFiles_BackupConfig *backupConfig; +/** Optional. Cache parameters for the volume. */ +@property(nonatomic, strong, nullable) GTLRNetAppFiles_CacheParameters *cacheParameters; + /** * Required. Capacity in GIB of the volume * diff --git a/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesQuery.h b/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesQuery.h index bf511c4a4..a1a4f81e4 100644 --- a/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesQuery.h +++ b/Sources/GeneratedServices/NetAppFiles/Public/GoogleAPIClientForREST/GTLRNetAppFilesQuery.h @@ -2232,6 +2232,39 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Restore files from a backup to a volume. + * + * Method: netapp.projects.locations.volumes.restore + * + * Authorization scope(s): + * @c kGTLRAuthScopeNetAppFilesCloudPlatform + */ +@interface GTLRNetAppFilesQuery_ProjectsLocationsVolumesRestore : GTLRNetAppFilesQuery + +/** + * Required. The volume resource name, in the format + * `projects/{project_id}/locations/{location}/volumes/{volume_id}` + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRNetAppFiles_Operation. + * + * Restore files from a backup to a volume. + * + * @param object The @c GTLRNetAppFiles_RestoreBackupFilesRequest to include in + * the query. + * @param name Required. The volume resource name, in the format + * `projects/{project_id}/locations/{location}/volumes/{volume_id}` + * + * @return GTLRNetAppFilesQuery_ProjectsLocationsVolumesRestore + */ ++ (instancetype)queryWithObject:(GTLRNetAppFiles_RestoreBackupFilesRequest *)object + name:(NSString *)name; + +@end + /** * Revert an existing volume to a specified snapshot. Warning! This operation * will permanently revert all changes made after the snapshot was created. diff --git a/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementObjects.m b/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementObjects.m index 1839df46e..4205b6057 100644 --- a/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementObjects.m +++ b/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementObjects.m @@ -325,25 +325,6 @@ NSString * const kGTLRNetworkManagement_LoadBalancerInfo_LoadBalancerType_SslProxy = @"SSL_PROXY"; NSString * const kGTLRNetworkManagement_LoadBalancerInfo_LoadBalancerType_TcpProxy = @"TCP_PROXY"; -// GTLRNetworkManagement_MonitoringPoint.connectionStatus -NSString * const kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_ConnectionStatusUnspecified = @"CONNECTION_STATUS_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_Offline = @"OFFLINE"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_Online = @"ONLINE"; - -// GTLRNetworkManagement_MonitoringPoint.errors -NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_DownloadFailed = @"DOWNLOAD_FAILED"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_ErrorCodeUnspecified = @"ERROR_CODE_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_NtpError = @"NTP_ERROR"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_UpgradeError = @"UPGRADE_ERROR"; - -// GTLRNetworkManagement_MonitoringPoint.upgradeType -NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Auto = @"AUTO"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_External = @"EXTERNAL"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Managed = @"MANAGED"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Manual = @"MANUAL"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Scheduled = @"SCHEDULED"; -NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_UpgradeTypeUnspecified = @"UPGRADE_TYPE_UNSPECIFIED"; - // GTLRNetworkManagement_NatInfo.type NSString * const kGTLRNetworkManagement_NatInfo_Type_CloudNat = @"CLOUD_NAT"; NSString * const kGTLRNetworkManagement_NatInfo_Type_ExternalToInternal = @"EXTERNAL_TO_INTERNAL"; @@ -352,32 +333,6 @@ NSString * const kGTLRNetworkManagement_NatInfo_Type_PrivateServiceConnect = @"PRIVATE_SERVICE_CONNECT"; NSString * const kGTLRNetworkManagement_NatInfo_Type_TypeUnspecified = @"TYPE_UNSPECIFIED"; -// GTLRNetworkManagement_NetworkMonitoringProvider.providerType -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_ProviderType_External = @"EXTERNAL"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_ProviderType_ProviderTypeUnspecified = @"PROVIDER_TYPE_UNSPECIFIED"; - -// GTLRNetworkManagement_NetworkMonitoringProvider.state -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Activating = @"ACTIVATING"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Active = @"ACTIVE"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Deleted = @"DELETED"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Deleting = @"DELETING"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_StateUnspecified = @"STATE_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Suspended = @"SUSPENDED"; -NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Suspending = @"SUSPENDING"; - -// GTLRNetworkManagement_NetworkPath.monitoringStatus -NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_Disabled = @"DISABLED"; -NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_Monitoring = @"MONITORING"; -NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_MonitoringPointOffline = @"MONITORING_POINT_OFFLINE"; -NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_MonitoringStatusUnspecified = @"MONITORING_STATUS_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_PolicyMismatch = @"POLICY_MISMATCH"; - -// GTLRNetworkManagement_NetworkPath.networkProtocol -NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Icmp = @"ICMP"; -NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_NetworkProtocolUnspecified = @"NETWORK_PROTOCOL_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Tcp = @"TCP"; -NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Udp = @"UDP"; - // GTLRNetworkManagement_ProbingDetails.abortCause NSString * const kGTLRNetworkManagement_ProbingDetails_AbortCause_NoSourceLocation = @"NO_SOURCE_LOCATION"; NSString * const kGTLRNetworkManagement_ProbingDetails_AbortCause_PermissionDenied = @"PERMISSION_DENIED"; @@ -390,13 +345,6 @@ NSString * const kGTLRNetworkManagement_ProbingDetails_Result_Undetermined = @"UNDETERMINED"; NSString * const kGTLRNetworkManagement_ProbingDetails_Result_Unreachable = @"UNREACHABLE"; -// GTLRNetworkManagement_ProviderTag.resourceType -NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_MonitoringPoint = @"MONITORING_POINT"; -NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_MonitoringPolicy = @"MONITORING_POLICY"; -NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_NetworkPath = @"NETWORK_PATH"; -NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_ResourceTypeUnspecified = @"RESOURCE_TYPE_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_WebPath = @"WEB_PATH"; - // GTLRNetworkManagement_ReachabilityDetails.result NSString * const kGTLRNetworkManagement_ReachabilityDetails_Result_Ambiguous = @"AMBIGUOUS"; NSString * const kGTLRNetworkManagement_ReachabilityDetails_Result_Reachable = @"REACHABLE"; @@ -519,18 +467,6 @@ NSString * const kGTLRNetworkManagement_VpnTunnelInfo_RoutingType_RouteBased = @"ROUTE_BASED"; NSString * const kGTLRNetworkManagement_VpnTunnelInfo_RoutingType_RoutingTypeUnspecified = @"ROUTING_TYPE_UNSPECIFIED"; -// GTLRNetworkManagement_WebPath.monitoringStatus -NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_Disabled = @"DISABLED"; -NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_Monitoring = @"MONITORING"; -NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_MonitoringPointOffline = @"MONITORING_POINT_OFFLINE"; -NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_MonitoringStatusUnspecified = @"MONITORING_STATUS_UNSPECIFIED"; -NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_PolicyMismatch = @"POLICY_MISMATCH"; - -// GTLRNetworkManagement_WebPath.workflowType -NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_Browser = @"BROWSER"; -NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_Http = @"HTTP"; -NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_WorkflowTypeUnspecified = @"WORKFLOW_TYPE_UNSPECIFIED"; - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_AbortInfo @@ -874,16 +810,6 @@ @implementation GTLRNetworkManagement_ForwardingRuleInfo @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_GeoLocation -// - -@implementation GTLRNetworkManagement_GeoLocation -@dynamic country, formattedAddress; -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_GKEMasterInfo @@ -904,25 +830,6 @@ @implementation GTLRNetworkManagement_GoogleServiceInfo @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_Host -// - -@implementation GTLRNetworkManagement_Host -@dynamic cloudInstanceId, cloudProjectId, cloudProvider, cloudRegion, - cloudVirtualNetworkIds, cloudVpcId, cloudZone, os; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"cloudVirtualNetworkIds" : [NSString class] - }; - return map; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_HybridSubnetInfo @@ -1037,83 +944,18 @@ + (NSString *)collectionItemsKey { @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_ListMonitoringPointsResponse -// - -@implementation GTLRNetworkManagement_ListMonitoringPointsResponse -@dynamic monitoringPoints, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"monitoringPoints" : [GTLRNetworkManagement_MonitoringPoint class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"monitoringPoints"; -} - -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_ListNetworkMonitoringProvidersResponse -// - -@implementation GTLRNetworkManagement_ListNetworkMonitoringProvidersResponse -@dynamic networkMonitoringProviders, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"networkMonitoringProviders" : [GTLRNetworkManagement_NetworkMonitoringProvider class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"networkMonitoringProviders"; -} - -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_ListNetworkPathsResponse -// - -@implementation GTLRNetworkManagement_ListNetworkPathsResponse -@dynamic networkPaths, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"networkPaths" : [GTLRNetworkManagement_NetworkPath class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"networkPaths"; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_ListOperationsResponse // @implementation GTLRNetworkManagement_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRNetworkManagement_Operation class] + @"operations" : [GTLRNetworkManagement_Operation class], + @"unreachable" : [NSString class] }; return map; } @@ -1148,28 +990,6 @@ + (NSString *)collectionItemsKey { @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_ListWebPathsResponse -// - -@implementation GTLRNetworkManagement_ListWebPathsResponse -@dynamic nextPageToken, webPaths; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"webPaths" : [GTLRNetworkManagement_WebPath class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"webPaths"; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_LoadBalancerBackend @@ -1258,29 +1078,6 @@ + (Class)classForAdditionalProperties { @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_MonitoringPoint -// - -@implementation GTLRNetworkManagement_MonitoringPoint -@dynamic autoGeoLocationEnabled, connectionStatus, createTime, displayName, - errors, geoLocation, host, hostname, name, networkInterfaces, - originatingIp, providerTags, type, updateTime, upgradeAvailable, - upgradeType, version; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"errors" : [NSString class], - @"networkInterfaces" : [GTLRNetworkManagement_NetworkInterface class], - @"providerTags" : [GTLRNetworkManagement_ProviderTag class] - }; - return map; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_NatInfo @@ -1303,56 +1100,6 @@ @implementation GTLRNetworkManagement_NetworkInfo @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_NetworkInterface -// - -@implementation GTLRNetworkManagement_NetworkInterface -@dynamic adapterDescription, cidr, interfaceName, ipAddress, macAddress, speed, - vlanId; -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_NetworkMonitoringProvider -// - -@implementation GTLRNetworkManagement_NetworkMonitoringProvider -@dynamic createTime, errors, name, providerType, providerUri, state, updateTime; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"errors" : [NSString class] - }; - return map; -} - -@end - - -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_NetworkPath -// - -@implementation GTLRNetworkManagement_NetworkPath -@dynamic createTime, destination, destinationGeoLocation, displayName, - dualEnded, monitoringEnabled, monitoringPolicyDisplayName, - monitoringPolicyId, monitoringStatus, name, networkProtocol, - providerTags, providerUiUri, sourceMonitoringPointId, updateTime; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"providerTags" : [GTLRNetworkManagement_ProviderTag class] - }; - return map; -} - -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_Operation @@ -1445,16 +1192,6 @@ @implementation GTLRNetworkManagement_ProbingDetails @end -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_ProviderTag -// - -@implementation GTLRNetworkManagement_ProviderTag -@dynamic category, resourceType, value; -@end - - // ---------------------------------------------------------------------------- // // GTLRNetworkManagement_ProxyConnectionInfo @@ -1815,24 +1552,3 @@ @implementation GTLRNetworkManagement_VpnTunnelInfo @dynamic displayName, networkUri, region, remoteGateway, remoteGatewayIp, routingType, sourceGateway, sourceGatewayIp, uri; @end - - -// ---------------------------------------------------------------------------- -// -// GTLRNetworkManagement_WebPath -// - -@implementation GTLRNetworkManagement_WebPath -@dynamic createTime, destination, displayName, interval, monitoringEnabled, - monitoringPolicyDisplayName, monitoringPolicyId, monitoringStatus, - name, providerTags, providerUiUri, relatedNetworkPathId, - sourceMonitoringPointId, updateTime, workflowType; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"providerTags" : [GTLRNetworkManagement_ProviderTag class] - }; - return map; -} - -@end diff --git a/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementQuery.m b/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementQuery.m index 5693aeca7..895785f78 100644 --- a/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementQuery.m +++ b/Sources/GeneratedServices/NetworkManagement/GTLRNetworkManagementQuery.m @@ -129,7 +129,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRNetworkManagementQuery_OrganizationsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -558,7 +558,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRNetworkManagementQuery_ProjectsLocationsGlobalOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -601,204 +601,6 @@ + (instancetype)queryWithName:(NSString *)name { @end -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersCreate - -@dynamic networkMonitoringProviderId, parent; - -+ (instancetype)queryWithObject:(GTLRNetworkManagement_NetworkMonitoringProvider *)object - parent:(NSString *)parent { - if (object == nil) { -#if defined(DEBUG) && DEBUG - NSAssert(object != nil, @"Got a nil object"); -#endif - return nil; - } - NSArray *pathParams = @[ @"parent" ]; - NSString *pathURITemplate = @"v1/{+parent}/networkMonitoringProviders"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersCreate *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"POST" - pathParameterNames:pathParams]; - query.bodyObject = object; - query.parent = parent; - query.expectedObjectClass = [GTLRNetworkManagement_Operation class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.create"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersDelete - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersDelete *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:@"DELETE" - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRNetworkManagement_Operation class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.delete"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersGet - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersGet *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRNetworkManagement_NetworkMonitoringProvider class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.get"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersList - -@dynamic pageSize, pageToken, parent; - -+ (instancetype)queryWithParent:(NSString *)parent { - NSArray *pathParams = @[ @"parent" ]; - NSString *pathURITemplate = @"v1/{+parent}/networkMonitoringProviders"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersList *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.parent = parent; - query.expectedObjectClass = [GTLRNetworkManagement_ListNetworkMonitoringProvidersResponse class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.list"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsGet - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsGet *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRNetworkManagement_MonitoringPoint class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsList - -@dynamic pageSize, pageToken, parent; - -+ (instancetype)queryWithParent:(NSString *)parent { - NSArray *pathParams = @[ @"parent" ]; - NSString *pathURITemplate = @"v1/{+parent}/monitoringPoints"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsList *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.parent = parent; - query.expectedObjectClass = [GTLRNetworkManagement_ListMonitoringPointsResponse class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsGet - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsGet *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRNetworkManagement_NetworkPath class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsList - -@dynamic pageSize, pageToken, parent; - -+ (instancetype)queryWithParent:(NSString *)parent { - NSArray *pathParams = @[ @"parent" ]; - NSString *pathURITemplate = @"v1/{+parent}/networkPaths"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsList *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.parent = parent; - query.expectedObjectClass = [GTLRNetworkManagement_ListNetworkPathsResponse class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsGet - -@dynamic name; - -+ (instancetype)queryWithName:(NSString *)name { - NSArray *pathParams = @[ @"name" ]; - NSString *pathURITemplate = @"v1/{+name}"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsGet *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.name = name; - query.expectedObjectClass = [GTLRNetworkManagement_WebPath class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get"; - return query; -} - -@end - -@implementation GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsList - -@dynamic pageSize, pageToken, parent; - -+ (instancetype)queryWithParent:(NSString *)parent { - NSArray *pathParams = @[ @"parent" ]; - NSString *pathURITemplate = @"v1/{+parent}/webPaths"; - GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsList *query = - [[self alloc] initWithPathURITemplate:pathURITemplate - HTTPMethod:nil - pathParameterNames:pathParams]; - query.parent = parent; - query.expectedObjectClass = [GTLRNetworkManagement_ListWebPathsResponse class]; - query.loggingName = @"networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list"; - return query; -} - -@end - @implementation GTLRNetworkManagementQuery_ProjectsLocationsVpcFlowLogsConfigsCreate @dynamic parent, vpcFlowLogsConfigId; diff --git a/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementObjects.h b/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementObjects.h index 7157f790b..61884572a 100644 --- a/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementObjects.h +++ b/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementObjects.h @@ -39,10 +39,8 @@ @class GTLRNetworkManagement_FirewallInfo; @class GTLRNetworkManagement_ForwardInfo; @class GTLRNetworkManagement_ForwardingRuleInfo; -@class GTLRNetworkManagement_GeoLocation; @class GTLRNetworkManagement_GKEMasterInfo; @class GTLRNetworkManagement_GoogleServiceInfo; -@class GTLRNetworkManagement_Host; @class GTLRNetworkManagement_HybridSubnetInfo; @class GTLRNetworkManagement_InstanceInfo; @class GTLRNetworkManagement_InterconnectAttachmentInfo; @@ -54,18 +52,13 @@ @class GTLRNetworkManagement_Location; @class GTLRNetworkManagement_Location_Labels; @class GTLRNetworkManagement_Location_Metadata; -@class GTLRNetworkManagement_MonitoringPoint; @class GTLRNetworkManagement_NatInfo; @class GTLRNetworkManagement_NetworkInfo; -@class GTLRNetworkManagement_NetworkInterface; -@class GTLRNetworkManagement_NetworkMonitoringProvider; -@class GTLRNetworkManagement_NetworkPath; @class GTLRNetworkManagement_Operation; @class GTLRNetworkManagement_Operation_Metadata; @class GTLRNetworkManagement_Operation_Response; @class GTLRNetworkManagement_Policy; @class GTLRNetworkManagement_ProbingDetails; -@class GTLRNetworkManagement_ProviderTag; @class GTLRNetworkManagement_ProxyConnectionInfo; @class GTLRNetworkManagement_ReachabilityDetails; @class GTLRNetworkManagement_RedisClusterInfo; @@ -84,7 +77,6 @@ @class GTLRNetworkManagement_VpcFlowLogsConfig_Labels; @class GTLRNetworkManagement_VpnGatewayInfo; @class GTLRNetworkManagement_VpnTunnelInfo; -@class GTLRNetworkManagement_WebPath; // Generated comments include content from the discovery document; avoid them // causing warnings since clang's checks are some what arbitrary. @@ -1946,96 +1938,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_LoadBalancerInfo_LoadB */ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_LoadBalancerInfo_LoadBalancerType_TcpProxy; -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_MonitoringPoint.connectionStatus - -/** - * The default value. This value is used if the status is omitted. - * - * Value: "CONNECTION_STATUS_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_ConnectionStatusUnspecified; -/** - * MonitoringPoint is offline. - * - * Value: "OFFLINE" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_Offline; -/** - * MonitoringPoint is online. - * - * Value: "ONLINE" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_Online; - -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_MonitoringPoint.errors - -/** - * Error detected while downloading. - * - * Value: "DOWNLOAD_FAILED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_DownloadFailed; -/** - * The default value. This value is used if the error code is omitted. - * - * Value: "ERROR_CODE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_ErrorCodeUnspecified; -/** - * Error detected in NTP service. - * - * Value: "NTP_ERROR" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_NtpError; -/** - * Error detected during the upgrade process. - * - * Value: "UPGRADE_ERROR" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_Errors_UpgradeError; - -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_MonitoringPoint.upgradeType - -/** - * Upgrades are performed automatically. - * - * Value: "AUTO" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Auto; -/** - * Upgrades are performed externally. - * - * Value: "EXTERNAL" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_External; -/** - * Upgrades are managed. - * - * Value: "MANAGED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Managed; -/** - * Upgrades are performed manually. - * - * Value: "MANUAL" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Manual; -/** - * Upgrade is scheduled. - * - * Value: "SCHEDULED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Scheduled; -/** - * The default value. This value is used if the upgrade type is omitted. - * - * Value: "UPGRADE_TYPE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_MonitoringPoint_UpgradeType_UpgradeTypeUnspecified; - // ---------------------------------------------------------------------------- // GTLRNetworkManagement_NatInfo.type @@ -2076,130 +1978,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NatInfo_Type_PrivateSe */ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NatInfo_Type_TypeUnspecified; -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_NetworkMonitoringProvider.providerType - -/** - * External provider. - * - * Value: "EXTERNAL" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_ProviderType_External; -/** - * The default value. This value is used if the type is omitted. - * - * Value: "PROVIDER_TYPE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_ProviderType_ProviderTypeUnspecified; - -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_NetworkMonitoringProvider.state - -/** - * NetworkMonitoringProvider is being activated. - * - * Value: "ACTIVATING" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Activating; -/** - * NetworkMonitoringProvider is active. - * - * Value: "ACTIVE" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Active; -/** - * NetworkMonitoringProvider is deleted. - * - * Value: "DELETED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Deleted; -/** - * NetworkMonitoringProvider is being deleted. - * - * Value: "DELETING" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Deleting; -/** - * The default value. This value is used if the status is omitted. - * - * Value: "STATE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_StateUnspecified; -/** - * NetworkMonitoringProvider is suspended. - * - * Value: "SUSPENDED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Suspended; -/** - * NetworkMonitoringProvider is being suspended. - * - * Value: "SUSPENDING" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkMonitoringProvider_State_Suspending; - -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_NetworkPath.monitoringStatus - -/** - * Monitoring is disabled. - * - * Value: "DISABLED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_Disabled; -/** - * Monitoring is enabled. - * - * Value: "MONITORING" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_Monitoring; -/** - * Monitoring point is offline. - * - * Value: "MONITORING_POINT_OFFLINE" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_MonitoringPointOffline; -/** - * The default value. This value is used if the status is omitted. - * - * Value: "MONITORING_STATUS_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_MonitoringStatusUnspecified; -/** - * Policy is mismatched. - * - * Value: "POLICY_MISMATCH" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_MonitoringStatus_PolicyMismatch; - -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_NetworkPath.networkProtocol - -/** - * ICMP. - * - * Value: "ICMP" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Icmp; -/** - * The default value. This value is used if the network protocol is omitted. - * - * Value: "NETWORK_PROTOCOL_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_NetworkProtocolUnspecified; -/** - * TCP. - * - * Value: "TCP" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Tcp; -/** - * UDP. - * - * Value: "UDP" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Udp; - // ---------------------------------------------------------------------------- // GTLRNetworkManagement_ProbingDetails.abortCause @@ -2260,40 +2038,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProbingDetails_Result_ */ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProbingDetails_Result_Unreachable; -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_ProviderTag.resourceType - -/** - * Monitoring point. - * - * Value: "MONITORING_POINT" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_MonitoringPoint; -/** - * Monitoring policy. - * - * Value: "MONITORING_POLICY" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_MonitoringPolicy; -/** - * Network path. - * - * Value: "NETWORK_PATH" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_NetworkPath; -/** - * The default value. This value is used if the status is omitted. - * - * Value: "RESOURCE_TYPE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_ResourceTypeUnspecified; -/** - * Web path. - * - * Value: "WEB_PATH" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_ProviderTag_ResourceType_WebPath; - // ---------------------------------------------------------------------------- // GTLRNetworkManagement_ReachabilityDetails.result @@ -2982,62 +2726,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_VpnTunnelInfo_RoutingT */ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_VpnTunnelInfo_RoutingType_RoutingTypeUnspecified; -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_WebPath.monitoringStatus - -/** - * Monitoring is disabled. - * - * Value: "DISABLED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_Disabled; -/** - * Monitoring is enabled. - * - * Value: "MONITORING" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_Monitoring; -/** - * Monitoring point is offline. - * - * Value: "MONITORING_POINT_OFFLINE" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_MonitoringPointOffline; -/** - * The default value. This value is used if the status is omitted. - * - * Value: "MONITORING_STATUS_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_MonitoringStatusUnspecified; -/** - * Policy is mismatched. - * - * Value: "POLICY_MISMATCH" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_MonitoringStatus_PolicyMismatch; - -// ---------------------------------------------------------------------------- -// GTLRNetworkManagement_WebPath.workflowType - -/** - * Browser. - * - * Value: "BROWSER" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_Browser; -/** - * HTTP. - * - * Value: "HTTP" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_Http; -/** - * The default value. This value is used if the status is omitted. - * - * Value: "WORKFLOW_TYPE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_WorkflowTypeUnspecified; - /** * Details of the final state "abort" and associated resource. */ @@ -4819,20 +4507,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * The geographical location of the MonitoringPoint. - */ -@interface GTLRNetworkManagement_GeoLocation : GTLRObject - -/** Country. */ -@property(nonatomic, copy, nullable) NSString *country; - -/** Formatted address. */ -@property(nonatomic, copy, nullable) NSString *formattedAddress; - -@end - - /** * For display only. Metadata associated with a Google Kubernetes Engine (GKE) * cluster master. @@ -4910,38 +4584,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * Message describing information about the host. - */ -@interface GTLRNetworkManagement_Host : GTLRObject - -/** Output only. The cloud instance id of the host. */ -@property(nonatomic, copy, nullable) NSString *cloudInstanceId; - -/** Output only. The cloud project id of the host. */ -@property(nonatomic, copy, nullable) NSString *cloudProjectId; - -/** Output only. The cloud provider of the host. */ -@property(nonatomic, copy, nullable) NSString *cloudProvider; - -/** Output only. The cloud region of the host. */ -@property(nonatomic, copy, nullable) NSString *cloudRegion; - -/** Output only. The ids of cloud virtual networks of the host. */ -@property(nonatomic, strong, nullable) NSArray *cloudVirtualNetworkIds; - -/** Output only. The id of Virtual Private Cloud (VPC) of the host. */ -@property(nonatomic, copy, nullable) NSString *cloudVpcId; - -/** Output only. The cloud zone of the host. */ -@property(nonatomic, copy, nullable) NSString *cloudZone; - -/** Output only. The operating system of the host. */ -@property(nonatomic, copy, nullable) NSString *os; - -@end - - /** * For display only. Metadata associated with a hybrid subnet. */ @@ -5154,78 +4796,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * Message for response to listing MonitoringPoints - * - * @note This class supports NSFastEnumeration and indexed subscripting over - * its "monitoringPoints" property. If returned as the result of a query, - * it should support automatic pagination (when @c shouldFetchNextPages - * is enabled). - */ -@interface GTLRNetworkManagement_ListMonitoringPointsResponse : GTLRCollectionObject - -/** - * The list of MonitoringPoints. - * - * @note This property is used to support NSFastEnumeration and indexed - * subscripting on this class. - */ -@property(nonatomic, strong, nullable) NSArray *monitoringPoints; - -/** A token identifying a page of results the server should return. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; - -@end - - -/** - * Message for response to listing NetworkMonitoringProviders - * - * @note This class supports NSFastEnumeration and indexed subscripting over - * its "networkMonitoringProviders" property. If returned as the result - * of a query, it should support automatic pagination (when @c - * shouldFetchNextPages is enabled). - */ -@interface GTLRNetworkManagement_ListNetworkMonitoringProvidersResponse : GTLRCollectionObject - -/** - * The list of NetworkMonitoringProvider - * - * @note This property is used to support NSFastEnumeration and indexed - * subscripting on this class. - */ -@property(nonatomic, strong, nullable) NSArray *networkMonitoringProviders; - -/** A token identifying a page of results the server should return. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; - -@end - - -/** - * Message for response to listing NetworkPaths - * - * @note This class supports NSFastEnumeration and indexed subscripting over - * its "networkPaths" property. If returned as the result of a query, it - * should support automatic pagination (when @c shouldFetchNextPages is - * enabled). - */ -@interface GTLRNetworkManagement_ListNetworkPathsResponse : GTLRCollectionObject - -/** - * The list of NetworkPath - * - * @note This property is used to support NSFastEnumeration and indexed - * subscripting on this class. - */ -@property(nonatomic, strong, nullable) NSArray *networkPaths; - -/** A token identifying a page of results the server should return. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; - -@end - - /** * The response message for Operations.ListOperations. * @@ -5247,6 +4817,13 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end @@ -5279,30 +4856,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * Message for response to listing WebPaths - * - * @note This class supports NSFastEnumeration and indexed subscripting over - * its "webPaths" property. If returned as the result of a query, it - * should support automatic pagination (when @c shouldFetchNextPages is - * enabled). - */ -@interface GTLRNetworkManagement_ListWebPathsResponse : GTLRCollectionObject - -/** A token identifying a page of results the server should return. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; - -/** - * The list of WebPath. - * - * @note This property is used to support NSFastEnumeration and indexed - * subscripting on this class. - */ -@property(nonatomic, strong, nullable) NSArray *webPaths; - -@end - - /** * For display only. Metadata associated with a specific load balancer backend. */ @@ -5546,108 +5099,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * Message describing MonitoringPoint resource. - */ -@interface GTLRNetworkManagement_MonitoringPoint : GTLRObject - -/** - * Output only. Indicates if automaitic geographic location is enabled for the - * MonitoringPoint. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *autoGeoLocationEnabled; - -/** - * Output only. Connection status of the MonitoringPoint. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_ConnectionStatusUnspecified - * The default value. This value is used if the status is omitted. - * (Value: "CONNECTION_STATUS_UNSPECIFIED") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_Offline - * MonitoringPoint is offline. (Value: "OFFLINE") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_ConnectionStatus_Online - * MonitoringPoint is online. (Value: "ONLINE") - */ -@property(nonatomic, copy, nullable) NSString *connectionStatus; - -/** Output only. The time the MonitoringPoint was created. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** Output only. Display name of the MonitoringPoint. */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Output only. The codes of errors detected in the MonitoringPoint. */ -@property(nonatomic, strong, nullable) NSArray *errors; - -/** Output only. The geographical location of the MonitoringPoint. ; */ -@property(nonatomic, strong, nullable) GTLRNetworkManagement_GeoLocation *geoLocation; - -/** Output only. The host information of the MonitoringPoint. */ -@property(nonatomic, strong, nullable) GTLRNetworkManagement_Host *host; - -/** Output only. The hostname of the MonitoringPoint. */ -@property(nonatomic, copy, nullable) NSString *hostname; - -/** - * Identifier. Name of the resource. Format: - * `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}` - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Output only. The network interfaces of the MonitoringPoint. */ -@property(nonatomic, strong, nullable) NSArray *networkInterfaces; - -/** - * Output only. IP address visible when MonitoringPoint connects to the - * provider. - */ -@property(nonatomic, copy, nullable) NSString *originatingIp; - -/** Output only. The provider tags of the MonitoringPoint. */ -@property(nonatomic, strong, nullable) NSArray *providerTags; - -/** Output only. Deployment type of the MonitoringPoint. */ -@property(nonatomic, copy, nullable) NSString *type; - -/** Output only. The time the MonitoringPoint was updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -/** - * Output only. Indicates if an upgrade is available for the MonitoringPoint. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *upgradeAvailable; - -/** - * Output only. The type of upgrade available for the MonitoringPoint. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Auto Upgrades - * are performed automatically. (Value: "AUTO") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_UpgradeType_External - * Upgrades are performed externally. (Value: "EXTERNAL") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Managed - * Upgrades are managed. (Value: "MANAGED") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Manual Upgrades - * are performed manually. (Value: "MANUAL") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_UpgradeType_Scheduled - * Upgrade is scheduled. (Value: "SCHEDULED") - * @arg @c kGTLRNetworkManagement_MonitoringPoint_UpgradeType_UpgradeTypeUnspecified - * The default value. This value is used if the upgrade type is omitted. - * (Value: "UPGRADE_TYPE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *upgradeType; - -/** Output only. Version of the software running on the MonitoringPoint. */ -@property(nonatomic, copy, nullable) NSString *version; - -@end - - /** * For display only. Metadata associated with NAT. */ @@ -5754,209 +5205,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * Message describing network interfaces. - */ -@interface GTLRNetworkManagement_NetworkInterface : GTLRObject - -/** Output only. The description of the interface. */ -@property(nonatomic, copy, nullable) NSString *adapterDescription; - -/** - * Output only. The IP address of the interface and subnet mask in CIDR format. - * Examples: 192.168.1.0/24, 2001:db8::/32 - */ -@property(nonatomic, copy, nullable) NSString *cidr; - -/** Output only. The name of the network interface. Examples: eth0, eno1 */ -@property(nonatomic, copy, nullable) NSString *interfaceName; - -/** Output only. The IP address of the interface. */ -@property(nonatomic, copy, nullable) NSString *ipAddress; - -/** Output only. The MAC address of the interface. */ -@property(nonatomic, copy, nullable) NSString *macAddress; - -/** - * Output only. Speed of the interface in millions of bits per second. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *speed; - -/** - * Output only. The id of the VLAN. - * - * Uses NSNumber of longLongValue. - */ -@property(nonatomic, strong, nullable) NSNumber *vlanId; - -@end - - -/** - * Message describing NetworkMonitoringProvider resource. - */ -@interface GTLRNetworkManagement_NetworkMonitoringProvider : GTLRObject - -/** Output only. The time the NetworkMonitoringProvider was created. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** - * Output only. The list of error messages detected for the - * NetworkMonitoringProvider. - */ -@property(nonatomic, strong, nullable) NSArray *errors; - -/** - * Output only. Identifier. Name of the resource. Format: - * `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}` - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Required. Type of the NetworkMonitoringProvider. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_ProviderType_External - * External provider. (Value: "EXTERNAL") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_ProviderType_ProviderTypeUnspecified - * The default value. This value is used if the type is omitted. (Value: - * "PROVIDER_TYPE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *providerType; - -/** Output only. Link to the provider's UI. */ -@property(nonatomic, copy, nullable) NSString *providerUri; - -/** - * Output only. State of the NetworkMonitoringProvider. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_Activating - * NetworkMonitoringProvider is being activated. (Value: "ACTIVATING") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_Active - * NetworkMonitoringProvider is active. (Value: "ACTIVE") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_Deleted - * NetworkMonitoringProvider is deleted. (Value: "DELETED") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_Deleting - * NetworkMonitoringProvider is being deleted. (Value: "DELETING") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_StateUnspecified - * The default value. This value is used if the status is omitted. - * (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_Suspended - * NetworkMonitoringProvider is suspended. (Value: "SUSPENDED") - * @arg @c kGTLRNetworkManagement_NetworkMonitoringProvider_State_Suspending - * NetworkMonitoringProvider is being suspended. (Value: "SUSPENDING") - */ -@property(nonatomic, copy, nullable) NSString *state; - -/** Output only. The time the NetworkMonitoringProvider was updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - - -/** - * Message describing NetworkPath resource. - */ -@interface GTLRNetworkManagement_NetworkPath : GTLRObject - -/** Output only. The time the NetworkPath was created. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** Output only. IP address or hostname of the network path destination. */ -@property(nonatomic, copy, nullable) NSString *destination; - -/** - * Output only. Geographical location of the destination MonitoringPoint. ; - */ -@property(nonatomic, strong, nullable) GTLRNetworkManagement_GeoLocation *destinationGeoLocation; - -/** Output only. The display name of the network path. */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** - * Output only. Indicates if the network path is dual ended. When true, the - * network path is measured both: from both source to destination, and from - * destination to source. When false, the network path is measured from the - * source through the destination back to the source (round trip measurement). - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *dualEnded; - -/** - * Output only. Is monitoring enabled for the network path. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *monitoringEnabled; - -/** Output only. Display name of the monitoring policy. */ -@property(nonatomic, copy, nullable) NSString *monitoringPolicyDisplayName; - -/** Output only. ID of monitoring policy. */ -@property(nonatomic, copy, nullable) NSString *monitoringPolicyId; - -/** - * Output only. The monitoring status of the network path. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_NetworkPath_MonitoringStatus_Disabled - * Monitoring is disabled. (Value: "DISABLED") - * @arg @c kGTLRNetworkManagement_NetworkPath_MonitoringStatus_Monitoring - * Monitoring is enabled. (Value: "MONITORING") - * @arg @c kGTLRNetworkManagement_NetworkPath_MonitoringStatus_MonitoringPointOffline - * Monitoring point is offline. (Value: "MONITORING_POINT_OFFLINE") - * @arg @c kGTLRNetworkManagement_NetworkPath_MonitoringStatus_MonitoringStatusUnspecified - * The default value. This value is used if the status is omitted. - * (Value: "MONITORING_STATUS_UNSPECIFIED") - * @arg @c kGTLRNetworkManagement_NetworkPath_MonitoringStatus_PolicyMismatch - * Policy is mismatched. (Value: "POLICY_MISMATCH") - */ -@property(nonatomic, copy, nullable) NSString *monitoringStatus; - -/** - * Identifier. Name of the resource. Format: - * `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}` - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Output only. The network protocol of the network path. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Icmp ICMP. - * (Value: "ICMP") - * @arg @c kGTLRNetworkManagement_NetworkPath_NetworkProtocol_NetworkProtocolUnspecified - * The default value. This value is used if the network protocol is - * omitted. (Value: "NETWORK_PROTOCOL_UNSPECIFIED") - * @arg @c kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Tcp TCP. - * (Value: "TCP") - * @arg @c kGTLRNetworkManagement_NetworkPath_NetworkProtocol_Udp UDP. - * (Value: "UDP") - */ -@property(nonatomic, copy, nullable) NSString *networkProtocol; - -/** Output only. The provider tags of the network path. */ -@property(nonatomic, strong, nullable) NSArray *providerTags; - -/** Output only. Link to provider's UI; link shows the NetworkPath. */ -@property(nonatomic, copy, nullable) NSString *providerUiUri; - -/** - * Output only. Provider's UUID of the source MonitoringPoint. This id may not - * point to a resource in the GCP. - */ -@property(nonatomic, copy, nullable) NSString *sourceMonitoringPointId; - -/** Output only. The time the NetworkPath was updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -@end - - /** * This resource represents a long-running operation that is the result of a * network API call. @@ -6261,38 +5509,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end -/** - * Message describing the provider tag. - */ -@interface GTLRNetworkManagement_ProviderTag : GTLRObject - -/** Output only. The category of the provider tag. */ -@property(nonatomic, copy, nullable) NSString *category; - -/** - * Output only. The resource type of the provider tag. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_ProviderTag_ResourceType_MonitoringPoint - * Monitoring point. (Value: "MONITORING_POINT") - * @arg @c kGTLRNetworkManagement_ProviderTag_ResourceType_MonitoringPolicy - * Monitoring policy. (Value: "MONITORING_POLICY") - * @arg @c kGTLRNetworkManagement_ProviderTag_ResourceType_NetworkPath - * Network path. (Value: "NETWORK_PATH") - * @arg @c kGTLRNetworkManagement_ProviderTag_ResourceType_ResourceTypeUnspecified - * The default value. This value is used if the status is omitted. - * (Value: "RESOURCE_TYPE_UNSPECIFIED") - * @arg @c kGTLRNetworkManagement_ProviderTag_ResourceType_WebPath Web path. - * (Value: "WEB_PATH") - */ -@property(nonatomic, copy, nullable) NSString *resourceType; - -/** Output only. The value of the provider tag. */ -@property(nonatomic, copy, nullable) NSString *value; - -@end - - /** * For display only. Metadata associated with ProxyConnection. */ @@ -7508,92 +6724,6 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkManagement_WebPath_WorkflowType_W @end - -/** - * Message describing WebPath resource. - */ -@interface GTLRNetworkManagement_WebPath : GTLRObject - -/** Output only. The time the WebPath was created. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - -/** Output only. Web monitoring target. */ -@property(nonatomic, copy, nullable) NSString *destination; - -/** Output only. Display name of the WebPath. */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Output only. Monitoring interval. */ -@property(nonatomic, strong, nullable) GTLRDuration *interval; - -/** - * Output only. Is monitoring enabled for the WebPath. - * - * Uses NSNumber of boolValue. - */ -@property(nonatomic, strong, nullable) NSNumber *monitoringEnabled; - -/** Output only. Display name of the monitoring policy. */ -@property(nonatomic, copy, nullable) NSString *monitoringPolicyDisplayName; - -/** Output only. ID of the monitoring policy. */ -@property(nonatomic, copy, nullable) NSString *monitoringPolicyId; - -/** - * Output only. The monitoring status of the WebPath. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_WebPath_MonitoringStatus_Disabled - * Monitoring is disabled. (Value: "DISABLED") - * @arg @c kGTLRNetworkManagement_WebPath_MonitoringStatus_Monitoring - * Monitoring is enabled. (Value: "MONITORING") - * @arg @c kGTLRNetworkManagement_WebPath_MonitoringStatus_MonitoringPointOffline - * Monitoring point is offline. (Value: "MONITORING_POINT_OFFLINE") - * @arg @c kGTLRNetworkManagement_WebPath_MonitoringStatus_MonitoringStatusUnspecified - * The default value. This value is used if the status is omitted. - * (Value: "MONITORING_STATUS_UNSPECIFIED") - * @arg @c kGTLRNetworkManagement_WebPath_MonitoringStatus_PolicyMismatch - * Policy is mismatched. (Value: "POLICY_MISMATCH") - */ -@property(nonatomic, copy, nullable) NSString *monitoringStatus; - -/** - * Identifier. Name of the resource. Format: - * `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}` - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Output only. The provider tags of the web path. */ -@property(nonatomic, strong, nullable) NSArray *providerTags; - -/** Output only. Link to provider's UI; link shows the WebPath. */ -@property(nonatomic, copy, nullable) NSString *providerUiUri; - -/** Output only. Provider's UUID of the related NetworkPath. */ -@property(nonatomic, copy, nullable) NSString *relatedNetworkPathId; - -/** Output only. ID of the source MonitoringPoint. */ -@property(nonatomic, copy, nullable) NSString *sourceMonitoringPointId; - -/** Output only. The time the WebPath was updated. */ -@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; - -/** - * Output only. The workflow type of the WebPath. - * - * Likely values: - * @arg @c kGTLRNetworkManagement_WebPath_WorkflowType_Browser Browser. - * (Value: "BROWSER") - * @arg @c kGTLRNetworkManagement_WebPath_WorkflowType_Http HTTP. (Value: - * "HTTP") - * @arg @c kGTLRNetworkManagement_WebPath_WorkflowType_WorkflowTypeUnspecified - * The default value. This value is used if the status is omitted. - * (Value: "WORKFLOW_TYPE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *workflowType; - -@end - NS_ASSUME_NONNULL_END #pragma clang diagnostic pop diff --git a/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementQuery.h b/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementQuery.h index 0a6019370..f67385298 100644 --- a/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementQuery.h +++ b/Sources/GeneratedServices/NetworkManagement/Public/GoogleAPIClientForREST/GTLRNetworkManagementQuery.h @@ -245,6 +245,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRNetworkManagement_ListOperationsResponse. * @@ -1080,6 +1091,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRNetworkManagement_ListOperationsResponse. * @@ -1153,399 +1175,6 @@ NS_ASSUME_NONNULL_BEGIN @end -/** - * Creates a NetworkMonitoringProvider resource. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.create - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersCreate : GTLRNetworkManagementQuery - -/** - * Required. The ID to use for the NetworkMonitoringProvider resource, which - * will become the final component of the NetworkMonitoringProvider resource's - * name. - */ -@property(nonatomic, copy, nullable) NSString *networkMonitoringProviderId; - -/** - * Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: - * projects/{project}/locations/{location} - */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** - * Fetches a @c GTLRNetworkManagement_Operation. - * - * Creates a NetworkMonitoringProvider resource. - * - * @param object The @c GTLRNetworkManagement_NetworkMonitoringProvider to - * include in the query. - * @param parent Required. Parent value for - * CreateNetworkMonitoringProviderRequest. Format: - * projects/{project}/locations/{location} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersCreate - */ -+ (instancetype)queryWithObject:(GTLRNetworkManagement_NetworkMonitoringProvider *)object - parent:(NSString *)parent; - -@end - -/** - * Deletes a NetworkMonitoringProvider resource and all of its child resources. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.delete - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersDelete : GTLRNetworkManagementQuery - -/** - * Required. Name of the resource. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRNetworkManagement_Operation. - * - * Deletes a NetworkMonitoringProvider resource and all of its child resources. - * - * @param name Required. Name of the resource. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersDelete - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * Gets the NetworkMonitoringProvider resource. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.get - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersGet : GTLRNetworkManagementQuery - -/** - * Required. Name of the resource. Format: - * `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}` - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRNetworkManagement_NetworkMonitoringProvider. - * - * Gets the NetworkMonitoringProvider resource. - * - * @param name Required. Name of the resource. Format: - * `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}` - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersGet - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * Lists NetworkMonitoringProviders for a given project and location. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.list - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersList : GTLRNetworkManagementQuery - -/** - * Optional. The maximum number of monitoring points to return. The service may - * return fewer than this value. If unspecified, at most 20 monitoring points - * will be returned. The maximum value is 1000; values above 1000 will be - * coerced to 1000. - */ -@property(nonatomic, assign) NSInteger pageSize; - -/** - * Optional. A page token, received from a previous `ListMonitoringPoints` - * call. Provide this to retrieve the subsequent page. When paginating, all - * other parameters provided to `ListMonitoringPoints` must match the call that - * provided the page token. - */ -@property(nonatomic, copy, nullable) NSString *pageToken; - -/** - * Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: - * `projects/{project}/locations/{location}` - */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** - * Fetches a @c GTLRNetworkManagement_ListNetworkMonitoringProvidersResponse. - * - * Lists NetworkMonitoringProviders for a given project and location. - * - * @param parent Required. Parent value for - * ListNetworkMonitoringProvidersRequest. Format: - * `projects/{project}/locations/{location}` - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. - */ -+ (instancetype)queryWithParent:(NSString *)parent; - -@end - -/** - * Gets the MonitoringPoint resource. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsGet : GTLRNetworkManagementQuery - -/** - * Required. Name of the resource. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRNetworkManagement_MonitoringPoint. - * - * Gets the MonitoringPoint resource. - * - * @param name Required. Name of the resource. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsGet - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * Lists MonitoringPoints for a given network monitoring provider. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsList : GTLRNetworkManagementQuery - -/** - * Optional. The maximum number of monitoring points to return. The service may - * return fewer than this value. If unspecified, at most 20 monitoring points - * will be returned. The maximum value is 1000; values above 1000 will be - * coerced to 1000. - */ -@property(nonatomic, assign) NSInteger pageSize; - -/** - * Optional. A page token, received from a previous `ListMonitoringPoints` - * call. Provide this to retrieve the subsequent page. When paginating, all - * other parameters provided to `ListMonitoringPoints` must match the call that - * provided the page token. - */ -@property(nonatomic, copy, nullable) NSString *pageToken; - -/** - * Required. Parent value for ListMonitoringPointsRequest. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** - * Fetches a @c GTLRNetworkManagement_ListMonitoringPointsResponse. - * - * Lists MonitoringPoints for a given network monitoring provider. - * - * @param parent Required. Parent value for ListMonitoringPointsRequest. - * Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. - */ -+ (instancetype)queryWithParent:(NSString *)parent; - -@end - -/** - * Gets the NetworkPath resource. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsGet : GTLRNetworkManagementQuery - -/** - * Required. Name of the resource. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path} - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRNetworkManagement_NetworkPath. - * - * Gets the NetworkPath resource. - * - * @param name Required. Name of the resource. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsGet - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * Lists NetworkPaths for a given network monitoring provider. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsList : GTLRNetworkManagementQuery - -/** - * Optional. The maximum number of network paths to return. The service may - * return fewer than this value. If unspecified, at most 20 network pathswill - * be returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. - */ -@property(nonatomic, assign) NSInteger pageSize; - -/** - * Optional. A page token, received from a previous `ListNetworkPaths` call. - * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListNetworkPaths` must match the call that provided - * the page token. - */ -@property(nonatomic, copy, nullable) NSString *pageToken; - -/** - * Required. Parent value for ListNetworkPathsRequest. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** - * Fetches a @c GTLRNetworkManagement_ListNetworkPathsResponse. - * - * Lists NetworkPaths for a given network monitoring provider. - * - * @param parent Required. Parent value for ListNetworkPathsRequest. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersNetworkPathsList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. - */ -+ (instancetype)queryWithParent:(NSString *)parent; - -@end - -/** - * Gets the WebPath resource. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsGet : GTLRNetworkManagementQuery - -/** - * Required. Name of the resource.. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path} - */ -@property(nonatomic, copy, nullable) NSString *name; - -/** - * Fetches a @c GTLRNetworkManagement_WebPath. - * - * Gets the WebPath resource. - * - * @param name Required. Name of the resource.. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsGet - */ -+ (instancetype)queryWithName:(NSString *)name; - -@end - -/** - * Lists WebPaths for a given network monitoring provider. - * - * Method: networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list - * - * Authorization scope(s): - * @c kGTLRAuthScopeNetworkManagementCloudPlatform - */ -@interface GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsList : GTLRNetworkManagementQuery - -/** - * Optional. The maximum number of web paths to return. The service may return - * fewer than this value. If unspecified, at most 20 web paths will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. - */ -@property(nonatomic, assign) NSInteger pageSize; - -/** - * Optional. A page token, received from a previous `ListWebPaths` call. - * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListWebPaths` must match the call that provided the - * page token. - */ -@property(nonatomic, copy, nullable) NSString *pageToken; - -/** - * Required. Parent value for ListWebPathsRequest. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** - * Fetches a @c GTLRNetworkManagement_ListWebPathsResponse. - * - * Lists WebPaths for a given network monitoring provider. - * - * @param parent Required. Parent value for ListWebPathsRequest. Format: - * projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} - * - * @return GTLRNetworkManagementQuery_ProjectsLocationsNetworkMonitoringProvidersWebPathsList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. - */ -+ (instancetype)queryWithParent:(NSString *)parent; - -@end - /** * Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same * settings already exists (even if the ID is different), the creation fails. diff --git a/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityObjects.m b/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityObjects.m index f926b081d..7209a5132 100644 --- a/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityObjects.m +++ b/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityObjects.m @@ -1719,11 +1719,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRNetworkSecurity_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRNetworkSecurity_Operation class] + @"operations" : [GTLRNetworkSecurity_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityQuery.m b/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityQuery.m index f19c49e25..fec99cd75 100644 --- a/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityQuery.m +++ b/Sources/GeneratedServices/NetworkSecurity/GTLRNetworkSecurityQuery.m @@ -403,7 +403,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRNetworkSecurityQuery_OrganizationsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -2950,7 +2950,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRNetworkSecurityQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityObjects.h b/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityObjects.h index 37f3494d2..96113728b 100644 --- a/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityObjects.h +++ b/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityObjects.h @@ -316,8 +316,9 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkSecurity_AuthzPolicy_Action_Deny; * client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the * principal selector. A match happens when there is an exact common name value * match. This is only applicable for Application Load Balancers except for - * classic Global External Application load balancer. CLIENT_CERT_COMMON_NAME - * is not supported for INTERNAL_SELF_MANAGED load balancing scheme. + * global external Application Load Balancer and classic Application Load + * Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED + * load balancing scheme. * * Value: "CLIENT_CERT_COMMON_NAME" */ @@ -1863,11 +1864,11 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkSecurity_TlsInspectionPolicy_TlsF * successfully validated by mTLS. Each identity is a string whose value is * matched against a list of URI SANs, DNS Name SANs, or the common name in the * client's certificate. A match happens when any principal matches with the - * rule. Limited to 50 principals per Authorization Policy for Regional - * Internal Application Load Balancer, Regional External Application Load - * Balancer, Cross-region Internal Application Load Balancer, and Cloud Service - * Mesh. Limited to 25 principals per Authorization Policy for Global External - * Application Load Balancer. + * rule. Limited to 50 principals per Authorization Policy for regional + * internal Application Load Balancers, regional external Application Load + * Balancers, cross-region internal Application Load Balancers, and Cloud + * Service Mesh. This field is not supported for global external Application + * Load Balancers. */ @property(nonatomic, strong, nullable) NSArray *principals; @@ -1938,9 +1939,9 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkSecurity_TlsInspectionPolicy_TlsF * the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is * set as the principal selector. A match happens when there is an exact * common name value match. This is only applicable for Application Load - * Balancers except for classic Global External Application load - * balancer. CLIENT_CERT_COMMON_NAME is not supported for - * INTERNAL_SELF_MANAGED load balancing scheme. (Value: + * Balancers except for global external Application Load Balancer and + * classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not + * supported for INTERNAL_SELF_MANAGED load balancing scheme. (Value: * "CLIENT_CERT_COMMON_NAME") * @arg @c kGTLRNetworkSecurity_AuthzPolicyAuthzRulePrincipal_PrincipalSelector_ClientCertDnsNameSan * The principal rule is matched against a list of DNS Name SANs in the @@ -2186,8 +2187,8 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkSecurity_TlsInspectionPolicy_TlsF /** * Required. All gateways and forwarding rules referenced by this policy and * extensions must share the same load balancing scheme. Supported values: - * `INTERNAL_MANAGED`, `INTERNAL_SELF_MANAGED`, and `EXTERNAL_MANAGED`. For - * more information, refer to [Backend services + * `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to + * [Backend services * overview](https://cloud.google.com/load-balancing/docs/backend-service). * * Likely values: @@ -2208,8 +2209,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkSecurity_TlsInspectionPolicy_TlsF /** * Required. A list of references to the Forwarding Rules on which this policy - * will be applied. For policies created for Cloudrun, this field will - * reference the Cloud Run services. + * will be applied. */ @property(nonatomic, strong, nullable) NSArray *resources; @@ -4457,6 +4457,13 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkSecurity_TlsInspectionPolicy_TlsF */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityQuery.h b/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityQuery.h index f6a399805..b5716cb2b 100644 --- a/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityQuery.h +++ b/Sources/GeneratedServices/NetworkSecurity/Public/GoogleAPIClientForREST/GTLRNetworkSecurityQuery.h @@ -769,6 +769,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRNetworkSecurity_ListOperationsResponse. * @@ -4526,8 +4537,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRNetworkSecurityQuery_ProjectsLocationsList : GTLRNetworkSecurityQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -5624,6 +5635,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRNetworkSecurity_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityObjects.m b/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityObjects.m index a049f85ca..ee78f1e9e 100644 --- a/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityObjects.m +++ b/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityObjects.m @@ -26,6 +26,23 @@ NSString * const kGTLRNetworkconnectivity_AuditLogConfig_LogType_DataWrite = @"DATA_WRITE"; NSString * const kGTLRNetworkconnectivity_AuditLogConfig_LogType_LogTypeUnspecified = @"LOG_TYPE_UNSPECIFIED"; +// GTLRNetworkconnectivity_CheckConsumerConfigRequest.requestedIpVersion +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_Ipv4 = @"IPV4"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_Ipv6 = @"IPV6"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_IpVersionUnspecified = @"IP_VERSION_UNSPECIFIED"; + +// GTLRNetworkconnectivity_CheckConsumerConfigResponse.errors +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_ConnectionPolicyMissing = @"CONNECTION_POLICY_MISSING"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_EndpointProjectApiNotEnabled = @"ENDPOINT_PROJECT_API_NOT_ENABLED"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_EndpointProjectInvalid = @"ENDPOINT_PROJECT_INVALID"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_EndpointProjectIsNotServiceProject = @"ENDPOINT_PROJECT_IS_NOT_SERVICE_PROJECT"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_ErrorUnspecified = @"ERROR_UNSPECIFIED"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_IpVersionNotSupported = @"IP_VERSION_NOT_SUPPORTED"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkInvalid = @"NETWORK_INVALID"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkProjectApisNotEnabled = @"NETWORK_PROJECT_APIS_NOT_ENABLED"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkProjectInvalid = @"NETWORK_PROJECT_INVALID"; +NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkProjectServiceAgentNotFound = @"NETWORK_PROJECT_SERVICE_AGENT_NOT_FOUND"; + // GTLRNetworkconnectivity_ConsumerPscConfig.ipVersion NSString * const kGTLRNetworkconnectivity_ConsumerPscConfig_IpVersion_Ipv4 = @"IPV4"; NSString * const kGTLRNetworkconnectivity_ConsumerPscConfig_IpVersion_Ipv6 = @"IPV6"; @@ -166,6 +183,35 @@ NSString * const kGTLRNetworkconnectivity_RegionalEndpoint_AccessType_Global = @"GLOBAL"; NSString * const kGTLRNetworkconnectivity_RegionalEndpoint_AccessType_Regional = @"REGIONAL"; +// GTLRNetworkconnectivity_RemoteTransportProfile.flow +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_InputOnly = @"INPUT_ONLY"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_InputOrOutput = @"INPUT_OR_OUTPUT"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_KeyProvisioningFlowUnspecified = @"KEY_PROVISIONING_FLOW_UNSPECIFIED"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_OutputOnly = @"OUTPUT_ONLY"; + +// GTLRNetworkconnectivity_RemoteTransportProfile.orderState +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_Closed = @"CLOSED"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_Open = @"OPEN"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_StateUnspecified = @"STATE_UNSPECIFIED"; + +// GTLRNetworkconnectivity_RemoteTransportProfile.sla +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_High = @"HIGH"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_Maximum = @"MAXIMUM"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_ServiceLevelAvailabilityUnspecified = @"SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED"; + +// GTLRNetworkconnectivity_RemoteTransportProfile.supportedBandwidths +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_BandwidthUnspecified = @"BANDWIDTH_UNSPECIFIED"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps100m = @"BPS_100M"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps10g = @"BPS_10G"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps1g = @"BPS_1G"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps200m = @"BPS_200M"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps2g = @"BPS_2G"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps300m = @"BPS_300M"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps400m = @"BPS_400M"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps500m = @"BPS_500M"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps50m = @"BPS_50M"; +NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps5g = @"BPS_5G"; + // GTLRNetworkconnectivity_Route.state NSString * const kGTLRNetworkconnectivity_Route_State_Accepting = @"ACCEPTING"; NSString * const kGTLRNetworkconnectivity_Route_State_Active = @"ACTIVE"; @@ -278,6 +324,31 @@ NSString * const kGTLRNetworkconnectivity_StateReason_Code_UpdatePendingReview = @"UPDATE_PENDING_REVIEW"; NSString * const kGTLRNetworkconnectivity_StateReason_Code_UpdateRejected = @"UPDATE_REJECTED"; +// GTLRNetworkconnectivity_Transport.bandwidth +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_BandwidthUnspecified = @"BANDWIDTH_UNSPECIFIED"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps100m = @"BPS_100M"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps10g = @"BPS_10G"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps1g = @"BPS_1G"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps200m = @"BPS_200M"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps2g = @"BPS_2G"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps300m = @"BPS_300M"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps400m = @"BPS_400M"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps500m = @"BPS_500M"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps50m = @"BPS_50M"; +NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps5g = @"BPS_5G"; + +// GTLRNetworkconnectivity_Transport.stackType +NSString * const kGTLRNetworkconnectivity_Transport_StackType_Ipv4Ipv6 = @"IPV4_IPV6"; +NSString * const kGTLRNetworkconnectivity_Transport_StackType_Ipv4Only = @"IPV4_ONLY"; +NSString * const kGTLRNetworkconnectivity_Transport_StackType_StackTypeUnspecified = @"STACK_TYPE_UNSPECIFIED"; + +// GTLRNetworkconnectivity_Transport.state +NSString * const kGTLRNetworkconnectivity_Transport_State_Active = @"ACTIVE"; +NSString * const kGTLRNetworkconnectivity_Transport_State_Creating = @"CREATING"; +NSString * const kGTLRNetworkconnectivity_Transport_State_PendingConfig = @"PENDING_CONFIG"; +NSString * const kGTLRNetworkconnectivity_Transport_State_PendingKey = @"PENDING_KEY"; +NSString * const kGTLRNetworkconnectivity_Transport_State_StateUnspecified = @"STATE_UNSPECIFIED"; + // GTLRNetworkconnectivity_Warnings.code NSString * const kGTLRNetworkconnectivity_Warnings_Code_ResourceBeingModified = @"RESOURCE_BEING_MODIFIED"; NSString * const kGTLRNetworkconnectivity_Warnings_Code_ResourceNotActive = @"RESOURCE_NOT_ACTIVE"; @@ -405,6 +476,34 @@ @implementation GTLRNetworkconnectivity_Binding @end +// ---------------------------------------------------------------------------- +// +// GTLRNetworkconnectivity_CheckConsumerConfigRequest +// + +@implementation GTLRNetworkconnectivity_CheckConsumerConfigRequest +@dynamic consumerNetwork, endpointProject, requestedIpVersion, serviceClass; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRNetworkconnectivity_CheckConsumerConfigResponse +// + +@implementation GTLRNetworkconnectivity_CheckConsumerConfigResponse +@dynamic errors; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"errors" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRNetworkconnectivity_ConsumerPscConfig @@ -572,11 +671,12 @@ @implementation GTLRNetworkconnectivity_GoogleLongrunningCancelOperationRequest // @implementation GTLRNetworkconnectivity_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRNetworkconnectivity_GoogleLongrunningOperation class] + @"operations" : [GTLRNetworkconnectivity_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } @@ -1767,7 +1867,20 @@ @implementation GTLRNetworkconnectivity_RejectSpokeUpdateRequest // @implementation GTLRNetworkconnectivity_RemoteTransportProfile -@dynamic createTime, labels, name, updateTime; +@dynamic createTime, descriptionProperty, flow, labels, name, orderState, + provider, providerSite, region, sla, supportedBandwidths, updateTime; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"supportedBandwidths" : [NSString class] + }; + return map; +} + @end @@ -2214,7 +2327,22 @@ @implementation GTLRNetworkconnectivity_TestIamPermissionsResponse // @implementation GTLRNetworkconnectivity_Transport -@dynamic createTime, labels, name, updateTime; +@dynamic adminEnabled, advertisedRoutes, bandwidth, createTime, + descriptionProperty, generatedActivationKey, labels, mtuLimit, name, + network, providedActivationKey, region, remoteProfile, stackType, + state, updateTime; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"advertisedRoutes" : [NSString class] + }; + return map; +} + @end diff --git a/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityQuery.m b/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityQuery.m index 5fce9b745..e35058047 100644 --- a/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityQuery.m +++ b/Sources/GeneratedServices/Networkconnectivity/GTLRNetworkconnectivityQuery.m @@ -39,6 +39,33 @@ @implementation GTLRNetworkconnectivityQuery @end +@implementation GTLRNetworkconnectivityQuery_ProjectsLocationsCheckConsumerConfig + +@dynamic location; + ++ (instancetype)queryWithObject:(GTLRNetworkconnectivity_CheckConsumerConfigRequest *)object + location:(NSString *)location { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"location" ]; + NSString *pathURITemplate = @"v1/{+location}:checkConsumerConfig"; + GTLRNetworkconnectivityQuery_ProjectsLocationsCheckConsumerConfig *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.location = location; + query.expectedObjectClass = [GTLRNetworkconnectivity_CheckConsumerConfigResponse class]; + query.loggingName = @"networkconnectivity.projects.locations.checkConsumerConfig"; + return query; +} + +@end + @implementation GTLRNetworkconnectivityQuery_ProjectsLocationsGet @dynamic name; @@ -1327,7 +1354,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRNetworkconnectivityQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityObjects.h b/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityObjects.h index e30b90349..82bd37ff8 100644 --- a/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityObjects.h +++ b/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityObjects.h @@ -188,6 +188,93 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_AuditLogConfig_LogTy */ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_AuditLogConfig_LogType_LogTypeUnspecified; +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_CheckConsumerConfigRequest.requestedIpVersion + +/** + * Will use IPv4 only. + * + * Value: "IPV4" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_Ipv4; +/** + * Will use IPv6 only. + * + * Value: "IPV6" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_Ipv6; +/** + * Default value. We will use IPv4 or IPv6 depending on the IP version of first + * available subnetwork. + * + * Value: "IP_VERSION_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_IpVersionUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_CheckConsumerConfigResponse.errors + +/** + * No ServiceConnectionPolicy found for this network and ServiceClass. + * + * Value: "CONNECTION_POLICY_MISSING" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_ConnectionPolicyMissing; +/** + * Network Connectivity API is not enabled in the endpoint project. + * + * Value: "ENDPOINT_PROJECT_API_NOT_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_EndpointProjectApiNotEnabled; +/** + * Invalid endpoint project. + * + * Value: "ENDPOINT_PROJECT_INVALID" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_EndpointProjectInvalid; +/** + * Endpoint project is not a service project of the network project. + * + * Value: "ENDPOINT_PROJECT_IS_NOT_SERVICE_PROJECT" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_EndpointProjectIsNotServiceProject; +/** + * An invalid error as the default case. + * + * Value: "ERROR_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_ErrorUnspecified; +/** + * IP version not supported in any of the subnetworks. + * + * Value: "IP_VERSION_NOT_SUPPORTED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_IpVersionNotSupported; +/** + * Invalid network. + * + * Value: "NETWORK_INVALID" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkInvalid; +/** + * Network Connectivity APIs not enabled in network project. + * + * Value: "NETWORK_PROJECT_APIS_NOT_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkProjectApisNotEnabled; +/** + * Invalid Network project. + * + * Value: "NETWORK_PROJECT_INVALID" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkProjectInvalid; +/** + * Service Agent missing for network project. + * + * Value: "NETWORK_PROJECT_SERVICE_AGENT_NOT_FOUND" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_CheckConsumerConfigResponse_Errors_NetworkProjectServiceAgentNotFound; + // ---------------------------------------------------------------------------- // GTLRNetworkconnectivity_ConsumerPscConfig.ipVersion @@ -916,6 +1003,154 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RegionalEndpoint_Acc */ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RegionalEndpoint_AccessType_Regional; +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_RemoteTransportProfile.flow + +/** + * The activationKey field on the Transport must be included in a create or + * patch request to establish connectivity. + * + * Value: "INPUT_ONLY" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_InputOnly; +/** + * Both activation key fields are allowed for establishing connectivity. If a + * key is input, the generated key is still present after provisioning is + * finished. + * + * Value: "INPUT_OR_OUTPUT" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_InputOrOutput; +/** + * Unspecified key provisioning flow. + * + * Value: "KEY_PROVISIONING_FLOW_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_KeyProvisioningFlowUnspecified; +/** + * The generatedActivationKey field is populated and must be read from the + * resource and passed into the other provider. + * + * Value: "OUTPUT_ONLY" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_OutputOnly; + +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_RemoteTransportProfile.orderState + +/** + * Not enough capacity for customers to order. + * + * Value: "CLOSED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_Closed; +/** + * Enough capacity to fulfill an order. + * + * Value: "OPEN" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_Open; +/** + * Unspecified state. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_StateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_RemoteTransportProfile.sla + +/** + * This represents a 99.9% service level on the availability of the configured + * connectivity. + * + * Value: "HIGH" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_High; +/** + * This represents a 99.99% service level on the availability of the configured + * connectivity. + * + * Value: "MAXIMUM" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_Maximum; +/** + * Unspecified service level availability. + * + * Value: "SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_ServiceLevelAvailabilityUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_RemoteTransportProfile.supportedBandwidths + +/** + * Unspecified bandwidth. + * + * Value: "BANDWIDTH_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_BandwidthUnspecified; +/** + * 100 Megabits per second. + * + * Value: "BPS_100M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps100m; +/** + * 10 Gigabits per second. + * + * Value: "BPS_10G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps10g; +/** + * 1 Gigabit per second. + * + * Value: "BPS_1G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps1g; +/** + * 200 Megabits per second. + * + * Value: "BPS_200M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps200m; +/** + * 2 Gigabits per second. + * + * Value: "BPS_2G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps2g; +/** + * 300 Megabits per second. + * + * Value: "BPS_300M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps300m; +/** + * 400 Megabits per second. + * + * Value: "BPS_400M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps400m; +/** + * 500 Megabits per second. + * + * Value: "BPS_500M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps500m; +/** + * 50 Megabits per second. + * + * Value: "BPS_50M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps50m; +/** + * 5 Gigabits per second. + * + * Value: "BPS_5G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_RemoteTransportProfile_SupportedBandwidths_Bps5g; + // ---------------------------------------------------------------------------- // GTLRNetworkconnectivity_Route.state @@ -1506,6 +1741,139 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_StateReason_Code_Upd */ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_StateReason_Code_UpdateRejected; +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_Transport.bandwidth + +/** + * Unspecified bandwidth. + * + * Value: "BANDWIDTH_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_BandwidthUnspecified; +/** + * 100 Megabits per second. + * + * Value: "BPS_100M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps100m; +/** + * 10 Gigabits per second. + * + * Value: "BPS_10G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps10g; +/** + * 1 Gigabit per second. + * + * Value: "BPS_1G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps1g; +/** + * 200 Megabits per second. + * + * Value: "BPS_200M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps200m; +/** + * 2 Gigabits per second. + * + * Value: "BPS_2G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps2g; +/** + * 300 Megabits per second. + * + * Value: "BPS_300M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps300m; +/** + * 400 Megabits per second. + * + * Value: "BPS_400M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps400m; +/** + * 500 Megabits per second. + * + * Value: "BPS_500M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps500m; +/** + * 50 Megabits per second. + * + * Value: "BPS_50M" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps50m; +/** + * 5 Gigabits per second. + * + * Value: "BPS_5G" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_Bandwidth_Bps5g; + +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_Transport.stackType + +/** + * Both IPv4 and IPv6 are supported. + * + * Value: "IPV4_IPV6" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_StackType_Ipv4Ipv6; +/** + * Only IPv4 is supported. (default) + * + * Value: "IPV4_ONLY" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_StackType_Ipv4Only; +/** + * Unspecified stack type. + * + * Value: "STACK_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_StackType_StackTypeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLRNetworkconnectivity_Transport.state + +/** + * The Transport is configured and the underlying connectivity is considered + * operational. + * + * Value: "ACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_State_Active; +/** + * The resource exists locally and is being created / associated with the + * resource on the remote provider’s end of the underlying connectivity. + * + * Value: "CREATING" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_State_Creating; +/** + * The Transport exists on both sides of the connection, and is waiting for + * configuration to finalize and be verified as operational. + * + * Value: "PENDING_CONFIG" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_State_PendingConfig; +/** + * The Transport was created in GCP. Depending on the profile’s key + * provisioning flow, this is either waiting for an activation key to be input + * (the key will be validated that it uses remote resources that match the + * Transport), or for the generated key to be input to the provider for + * finalizing. The configured bandwidth is not yet guaranteed. + * + * Value: "PENDING_KEY" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_State_PendingKey; +/** + * Unspecified state. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Transport_State_StateUnspecified; + // ---------------------------------------------------------------------------- // GTLRNetworkconnectivity_Warnings.code @@ -1851,6 +2219,54 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin @end +/** + * Request for CheckConsumerConfig. + */ +@interface GTLRNetworkconnectivity_CheckConsumerConfigRequest : GTLRObject + +/** + * Required. Full resource name of the consumer network. Example: - + * projects/{project}/global/networks/{network}. + */ +@property(nonatomic, copy, nullable) NSString *consumerNetwork; + +/** The project number or ID where the PSC endpoint is to be created. */ +@property(nonatomic, copy, nullable) NSString *endpointProject; + +/** + * The requested IP Version + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_Ipv4 + * Will use IPv4 only. (Value: "IPV4") + * @arg @c kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_Ipv6 + * Will use IPv6 only. (Value: "IPV6") + * @arg @c kGTLRNetworkconnectivity_CheckConsumerConfigRequest_RequestedIpVersion_IpVersionUnspecified + * Default value. We will use IPv4 or IPv6 depending on the IP version of + * first available subnetwork. (Value: "IP_VERSION_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *requestedIpVersion; + +/** Required. The service class identifier of the producer. */ +@property(nonatomic, copy, nullable) NSString *serviceClass; + +@end + + +/** + * Response for CheckConsumerConfig. + */ +@interface GTLRNetworkconnectivity_CheckConsumerConfigResponse : GTLRObject + +/** + * List of validation errors. If the list is empty, the consumer config is + * valid. + */ +@property(nonatomic, strong, nullable) NSArray *errors; + +@end + + /** * Allow the producer to specify which consumers can connect to it. */ @@ -2361,6 +2777,13 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end @@ -3521,7 +3944,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin @property(nonatomic, copy, nullable) NSString *nextPageToken; /** - * The list of RemoteTransportProfiles + * The list of RemoteTransportProfiles. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. @@ -3748,7 +4171,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin /** - * Message for response to listing Transports + * Message for response to listing Transports. * * @note This class supports NSFastEnumeration and indexed subscripting over * its "transports" property. If returned as the result of a query, it @@ -3761,7 +4184,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin @property(nonatomic, copy, nullable) NSString *nextPageToken; /** - * The list of Transport + * The list of Transport. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. @@ -4692,8 +5115,8 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin @property(nonatomic, copy, nullable) NSString *name; /** - * The name of the VPC network for this private regional endpoint. Format: - * `projects/{project}/global/networks/{network}` + * Optional. The name of the VPC network for this private regional endpoint. + * Format: `projects/{project}/global/networks/{network}` */ @property(nonatomic, copy, nullable) NSString *network; @@ -4705,8 +5128,9 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin @property(nonatomic, copy, nullable) NSString *pscForwardingRule; /** - * The name of the subnetwork from which the IP address will be allocated. - * Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` + * Optional. The name of the subnetwork from which the IP address will be + * allocated. Format: + * `projects/{project}/regions/{region}/subnetworks/{subnetwork}` */ @property(nonatomic, copy, nullable) NSString *subnetwork; @@ -4808,27 +5232,109 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin /** - * Message describing RemoteTransportProfile object + * Message describing RemoteTransportProfile object. */ @interface GTLRNetworkconnectivity_RemoteTransportProfile : GTLRObject -/** Output only. [Output only] Create time stamp */ +/** Output only. [Output only] Create time stamp. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** Optional. Labels as key value pairs */ +/** + * Output only. Description of the profile. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** + * Output only. [Output only] Type of provisioning flows supported by this + * profile. + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_InputOnly The + * activationKey field on the Transport must be included in a create or + * patch request to establish connectivity. (Value: "INPUT_ONLY") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_InputOrOutput + * Both activation key fields are allowed for establishing connectivity. + * If a key is input, the generated key is still present after + * provisioning is finished. (Value: "INPUT_OR_OUTPUT") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_KeyProvisioningFlowUnspecified + * Unspecified key provisioning flow. (Value: + * "KEY_PROVISIONING_FLOW_UNSPECIFIED") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Flow_OutputOnly + * The generatedActivationKey field is populated and must be read from + * the resource and passed into the other provider. (Value: + * "OUTPUT_ONLY") + */ +@property(nonatomic, copy, nullable) NSString *flow; + +/** Output only. Labels as key value pairs. */ @property(nonatomic, strong, nullable) GTLRNetworkconnectivity_RemoteTransportProfile_Labels *labels; -/** Identifier. name of resource */ +/** Identifier. Name of the resource in the format of $provider-$site. */ @property(nonatomic, copy, nullable) NSString *name; -/** Output only. [Output only] Update time stamp */ +/** + * Output only. [Output only] Order state for this profile. + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_Closed + * Not enough capacity for customers to order. (Value: "CLOSED") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_Open + * Enough capacity to fulfill an order. (Value: "OPEN") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_OrderState_StateUnspecified + * Unspecified state. (Value: "STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *orderState; + +/** + * Output only. Name of the provider on the other end of this profile. E.g. + * “Amazon Web Services” or “Microsoft Azure”. + */ +@property(nonatomic, copy, nullable) NSString *provider; + +/** + * Output only. If the profile is a Cloud Service Provider with compute + * resources, this is populated with the region where connectivity is being + * established. If the profile provides facility-level selection, this is an + * identity of the facility any connections on this profile are going through. + */ +@property(nonatomic, copy, nullable) NSString *providerSite; + +/** Output only. GCP Region where this profile is available. */ +@property(nonatomic, copy, nullable) NSString *region; + +/** + * Output only. [Output only] Availability class that will be configured for + * this particular RemoteTransportProfile. + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_High This + * represents a 99.9% service level on the availability of the configured + * connectivity. (Value: "HIGH") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_Maximum This + * represents a 99.99% service level on the availability of the + * configured connectivity. (Value: "MAXIMUM") + * @arg @c kGTLRNetworkconnectivity_RemoteTransportProfile_Sla_ServiceLevelAvailabilityUnspecified + * Unspecified service level availability. (Value: + * "SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *sla; + +/** + * Output only. List of bandwidth enum values that are supported by this + * profile. + */ +@property(nonatomic, strong, nullable) NSArray *supportedBandwidths; + +/** Output only. [Output only] Update time stamp. */ @property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Optional. Labels as key value pairs + * Output only. Labels as key value pairs. * * @note This class is documented as having more properties of NSString. Use @c * -additionalJSONKeys and @c -additionalPropertyForName: to get the list @@ -5903,27 +6409,164 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivity_Warnings_Code_Warnin /** - * Message describing Transport object + * Message describing Transport object. */ @interface GTLRNetworkconnectivity_Transport : GTLRObject -/** Output only. [Output only] Create time stamp */ +/** + * Optional. Administrative state of the underlying connectivity. If set to + * true (default), connectivity should be available between your environments. + * If set to false, the connectivity over these links is disabled. Disabling + * your Transport does not affect billing, and retains the underlying network + * bandwidth associated with the connectivity. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *adminEnabled; + +/** + * Optional. [Preview only] List of IP Prefixes that will be advertised to the + * remote provider. Both IPv4 and IPv6 addresses are supported. + */ +@property(nonatomic, strong, nullable) NSArray *advertisedRoutes; + +/** + * Required. Bandwidth of the Transport. This must be one of the supported + * bandwidths for the remote profile. + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_BandwidthUnspecified + * Unspecified bandwidth. (Value: "BANDWIDTH_UNSPECIFIED") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps100m 100 Megabits + * per second. (Value: "BPS_100M") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps10g 10 Gigabits + * per second. (Value: "BPS_10G") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps1g 1 Gigabit per + * second. (Value: "BPS_1G") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps200m 200 Megabits + * per second. (Value: "BPS_200M") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps2g 2 Gigabits per + * second. (Value: "BPS_2G") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps300m 300 Megabits + * per second. (Value: "BPS_300M") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps400m 400 Megabits + * per second. (Value: "BPS_400M") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps500m 500 Megabits + * per second. (Value: "BPS_500M") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps50m 50 Megabits + * per second. (Value: "BPS_50M") + * @arg @c kGTLRNetworkconnectivity_Transport_Bandwidth_Bps5g 5 Gigabits per + * second. (Value: "BPS_5G") + */ +@property(nonatomic, copy, nullable) NSString *bandwidth; + +/** Output only. [Output only] Create time stamp. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** Optional. Labels as key value pairs */ +/** + * Optional. Description of the Transport. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. + */ +@property(nonatomic, copy, nullable) NSString *descriptionProperty; + +/** + * Output only. [Output only] Google-generated activation key. This is only + * output if the selected profile supports an OUTPUT key flow. Inputting this + * to the provider is only valid while the resource is in a PENDING_KEY state. + * Once the provider has accepted the key, the resource will move to the + * CONFIGURING state. + */ +@property(nonatomic, copy, nullable) NSString *generatedActivationKey; + +/** Optional. Labels as key value pairs. */ @property(nonatomic, strong, nullable) GTLRNetworkconnectivity_Transport_Labels *labels; -/** Identifier. name of resource */ +/** + * Output only. [Output only] The maximum transmission unit (MTU) of a packet + * that can be sent over this transport. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *mtuLimit; + +/** + * Identifier. Name of the resource, see google.aip.dev/122 for resource + * naming. + */ @property(nonatomic, copy, nullable) NSString *name; -/** Output only. [Output only] Update time stamp */ +/** + * Required. [Preview only] Resource URL of the Network that will be peered + * with this Transport. This field must be provided during resource creation + * and cannot be changed. + */ +@property(nonatomic, copy, nullable) NSString *network; + +/** + * Optional. Key used for establishing a connection with the remote transport. + * This key can only be provided if the profile supports an INPUT key flow and + * the resource is in the PENDING_KEY state. + */ +@property(nonatomic, copy, nullable) NSString *providedActivationKey; + +/** Required. GCP Region where this Transport is located. */ +@property(nonatomic, copy, nullable) NSString *region; + +/** + * Required. Resource URL of the remoteTransportProfile that this Transport is + * connecting to. Format: + * projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile} + */ +@property(nonatomic, copy, nullable) NSString *remoteProfile; + +/** + * Optional. IP version stack for the established connectivity. + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_Transport_StackType_Ipv4Ipv6 Both IPv4 + * and IPv6 are supported. (Value: "IPV4_IPV6") + * @arg @c kGTLRNetworkconnectivity_Transport_StackType_Ipv4Only Only IPv4 is + * supported. (default) (Value: "IPV4_ONLY") + * @arg @c kGTLRNetworkconnectivity_Transport_StackType_StackTypeUnspecified + * Unspecified stack type. (Value: "STACK_TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *stackType; + +/** + * Output only. [Output only] State of the underlying connectivity. + * + * Likely values: + * @arg @c kGTLRNetworkconnectivity_Transport_State_Active The Transport is + * configured and the underlying connectivity is considered operational. + * (Value: "ACTIVE") + * @arg @c kGTLRNetworkconnectivity_Transport_State_Creating The resource + * exists locally and is being created / associated with the resource on + * the remote provider’s end of the underlying connectivity. (Value: + * "CREATING") + * @arg @c kGTLRNetworkconnectivity_Transport_State_PendingConfig The + * Transport exists on both sides of the connection, and is waiting for + * configuration to finalize and be verified as operational. (Value: + * "PENDING_CONFIG") + * @arg @c kGTLRNetworkconnectivity_Transport_State_PendingKey The Transport + * was created in GCP. Depending on the profile’s key provisioning flow, + * this is either waiting for an activation key to be input (the key will + * be validated that it uses remote resources that match the Transport), + * or for the generated key to be input to the provider for finalizing. + * The configured bandwidth is not yet guaranteed. (Value: "PENDING_KEY") + * @arg @c kGTLRNetworkconnectivity_Transport_State_StateUnspecified + * Unspecified state. (Value: "STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** Output only. [Output only] Update time stamp. */ @property(nonatomic, strong, nullable) GTLRDateTime *updateTime; @end /** - * Optional. Labels as key value pairs + * Optional. Labels as key value pairs. * * @note This class is documented as having more properties of NSString. Use @c * -additionalJSONKeys and @c -additionalPropertyForName: to get the list diff --git a/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityQuery.h b/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityQuery.h index a5453a2e8..8ca186797 100644 --- a/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityQuery.h +++ b/Sources/GeneratedServices/Networkconnectivity/Public/GoogleAPIClientForREST/GTLRNetworkconnectivityQuery.h @@ -117,6 +117,53 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif @end +/** + * CheckConsumerConfig validates the consumer network and project for potential + * PSC connection creation. This method performs several checks, including: - + * Validating the existence and permissions of the service class. - Ensuring + * the consumer network exists and is accessible. - Verifying XPN relationships + * if applicable. - Checking for compatible IP versions between the consumer + * network and the requested version. This method performs a dynamic IAM check + * for the `networkconnectivity.serviceClasses.use` permission on the service + * class resource in the Prepare phase. + * + * Method: networkconnectivity.projects.locations.checkConsumerConfig + * + * Authorization scope(s): + * @c kGTLRAuthScopeNetworkconnectivityCloudPlatform + */ +@interface GTLRNetworkconnectivityQuery_ProjectsLocationsCheckConsumerConfig : GTLRNetworkconnectivityQuery + +/** + * Required. The location resource path. Example: - + * projects/{project}/locations/{location} + */ +@property(nonatomic, copy, nullable) NSString *location; + +/** + * Fetches a @c GTLRNetworkconnectivity_CheckConsumerConfigResponse. + * + * CheckConsumerConfig validates the consumer network and project for potential + * PSC connection creation. This method performs several checks, including: - + * Validating the existence and permissions of the service class. - Ensuring + * the consumer network exists and is accessible. - Verifying XPN relationships + * if applicable. - Checking for compatible IP versions between the consumer + * network and the requested version. This method performs a dynamic IAM check + * for the `networkconnectivity.serviceClasses.use` permission on the service + * class resource in the Prepare phase. + * + * @param object The @c GTLRNetworkconnectivity_CheckConsumerConfigRequest to + * include in the query. + * @param location Required. The location resource path. Example: - + * projects/{project}/locations/{location} + * + * @return GTLRNetworkconnectivityQuery_ProjectsLocationsCheckConsumerConfig + */ ++ (instancetype)queryWithObject:(GTLRNetworkconnectivity_CheckConsumerConfigRequest *)object + location:(NSString *)location; + +@end + /** * Gets information about a location. * @@ -1818,8 +1865,8 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif @interface GTLRNetworkconnectivityQuery_ProjectsLocationsList : GTLRNetworkconnectivityQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -2536,6 +2583,17 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c * GTLRNetworkconnectivity_GoogleLongrunningListOperationsResponse. @@ -2731,7 +2789,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @interface GTLRNetworkconnectivityQuery_ProjectsLocationsRemoteTransportProfilesGet : GTLRNetworkconnectivityQuery -/** Required. Name of the resource */ +/** Required. Name of the resource. */ @property(nonatomic, copy, nullable) NSString *name; /** @@ -2739,7 +2797,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif * * Gets details of a single RemoteTransportProfile. * - * @param name Required. Name of the resource + * @param name Required. Name of the resource. * * @return GTLRNetworkconnectivityQuery_ProjectsLocationsRemoteTransportProfilesGet */ @@ -2757,10 +2815,10 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @interface GTLRNetworkconnectivityQuery_ProjectsLocationsRemoteTransportProfilesList : GTLRNetworkconnectivityQuery -/** Optional. Filtering results */ +/** Optional. Filtering results. */ @property(nonatomic, copy, nullable) NSString *filter; -/** Optional. Hint for how to order the results */ +/** Optional. Hint for how to order the results. */ @property(nonatomic, copy, nullable) NSString *orderBy; /** @@ -2774,7 +2832,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @property(nonatomic, copy, nullable) NSString *pageToken; -/** Required. Parent value for ListRemoteTransportProfilesRequest */ +/** Required. Parent value for ListRemoteTransportProfilesRequest. */ @property(nonatomic, copy, nullable) NSString *parent; /** @@ -2782,7 +2840,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif * * Lists RemoteTransportProfiles in a given project and location. * - * @param parent Required. Parent value for ListRemoteTransportProfilesRequest + * @param parent Required. Parent value for ListRemoteTransportProfilesRequest. * * @return GTLRNetworkconnectivityQuery_ProjectsLocationsRemoteTransportProfilesList * @@ -4475,7 +4533,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @interface GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsDelete : GTLRNetworkconnectivityQuery -/** Required. Name of the resource */ +/** Required. Name of the resource. */ @property(nonatomic, copy, nullable) NSString *name; /** @@ -4498,7 +4556,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif * * Deletes a single Transport. * - * @param name Required. Name of the resource + * @param name Required. Name of the resource. * * @return GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsDelete */ @@ -4516,7 +4574,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @interface GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsGet : GTLRNetworkconnectivityQuery -/** Required. Name of the resource */ +/** Required. Name of the resource. */ @property(nonatomic, copy, nullable) NSString *name; /** @@ -4524,7 +4582,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif * * Gets details of a single Transport. * - * @param name Required. Name of the resource + * @param name Required. Name of the resource. * * @return GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsGet */ @@ -4542,10 +4600,10 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @interface GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsList : GTLRNetworkconnectivityQuery -/** Optional. Filtering results */ +/** Optional. Filtering results. */ @property(nonatomic, copy, nullable) NSString *filter; -/** Optional. Hint for how to order the results */ +/** Optional. Hint for how to order the results. */ @property(nonatomic, copy, nullable) NSString *orderBy; /** @@ -4559,7 +4617,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @property(nonatomic, copy, nullable) NSString *pageToken; -/** Required. Parent value for ListTransportsRequest */ +/** Required. Parent value for ListTransportsRequest. */ @property(nonatomic, copy, nullable) NSString *parent; /** @@ -4567,7 +4625,7 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif * * Lists Transports in a given project and location. * - * @param parent Required. Parent value for ListTransportsRequest + * @param parent Required. Parent value for ListTransportsRequest. * * @return GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsList * @@ -4589,7 +4647,10 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif */ @interface GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsPatch : GTLRNetworkconnectivityQuery -/** Identifier. name of resource */ +/** + * Identifier. Name of the resource, see google.aip.dev/122 for resource + * naming. + */ @property(nonatomic, copy, nullable) NSString *name; /** @@ -4625,7 +4686,8 @@ FOUNDATION_EXTERN NSString * const kGTLRNetworkconnectivityViewSpokeViewUnspecif * * @param object The @c GTLRNetworkconnectivity_Transport to include in the * query. - * @param name Identifier. name of resource + * @param name Identifier. Name of the resource, see google.aip.dev/122 for + * resource naming. * * @return GTLRNetworkconnectivityQuery_ProjectsLocationsTransportsPatch */ diff --git a/Sources/GeneratedServices/OSConfig/GTLROSConfigObjects.m b/Sources/GeneratedServices/OSConfig/GTLROSConfigObjects.m index 5e3e90aa5..b2ecd2caa 100644 --- a/Sources/GeneratedServices/OSConfig/GTLROSConfigObjects.m +++ b/Sources/GeneratedServices/OSConfig/GTLROSConfigObjects.m @@ -312,11 +312,12 @@ @implementation GTLROSConfig_GoogleCloudOsconfigV2PolicyOrchestratorOrchestratio // @implementation GTLROSConfig_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLROSConfig_Operation class] + @"operations" : [GTLROSConfig_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/OSConfig/GTLROSConfigQuery.m b/Sources/GeneratedServices/OSConfig/GTLROSConfigQuery.m index 114370948..61e2bb9b0 100644 --- a/Sources/GeneratedServices/OSConfig/GTLROSConfigQuery.m +++ b/Sources/GeneratedServices/OSConfig/GTLROSConfigQuery.m @@ -199,7 +199,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLROSConfigQuery_FoldersLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -398,7 +398,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLROSConfigQuery_OrganizationsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -597,7 +597,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLROSConfigQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigObjects.h b/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigObjects.h index cbc60738a..56dea5eec 100644 --- a/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigObjects.h +++ b/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigObjects.h @@ -907,6 +907,13 @@ FOUNDATION_EXTERN NSString * const kGTLROSConfig_OSPolicyResourceRepositoryResou */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigQuery.h b/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigQuery.h index ef0da73cd..2571bc852 100644 --- a/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigQuery.h +++ b/Sources/GeneratedServices/OSConfig/Public/GoogleAPIClientForREST/GTLROSConfigQuery.h @@ -415,6 +415,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLROSConfig_ListOperationsResponse. * @@ -816,6 +827,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLROSConfig_ListOperationsResponse. * @@ -1215,6 +1237,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLROSConfig_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningObjects.m b/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningObjects.m index a6cff79bd..ed536b937 100644 --- a/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningObjects.m +++ b/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningObjects.m @@ -1108,11 +1108,12 @@ @implementation GTLROnDemandScanning_License // @implementation GTLROnDemandScanning_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLROnDemandScanning_Operation class] + @"operations" : [GTLROnDemandScanning_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningQuery.m b/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningQuery.m index 6fce60d67..2f0fbd5a3 100644 --- a/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningQuery.m +++ b/Sources/GeneratedServices/OnDemandScanning/GTLROnDemandScanningQuery.m @@ -75,7 +75,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLROnDemandScanningQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningObjects.h b/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningObjects.h index 643b94814..6f4a16037 100644 --- a/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningObjects.h +++ b/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningObjects.h @@ -2530,6 +2530,13 @@ FOUNDATION_EXTERN NSString * const kGTLROnDemandScanning_VulnerabilityOccurrence */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningQuery.h b/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningQuery.h index ac5734eb4..7e85f5b40 100644 --- a/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningQuery.h +++ b/Sources/GeneratedServices/OnDemandScanning/Public/GoogleAPIClientForREST/GTLROnDemandScanningQuery.h @@ -160,6 +160,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLROnDemandScanning_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseObjects.m b/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseObjects.m index a8570479f..266f375ae 100644 --- a/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseObjects.m +++ b/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseObjects.m @@ -170,6 +170,14 @@ NSString * const kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Dw = @"DW"; NSString * const kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Oltp = @"OLTP"; +// GTLROracleDatabase_BackupDestinationDetails.type +NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_BackupDestinationTypeUnspecified = @"BACKUP_DESTINATION_TYPE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_Dbrs = @"DBRS"; +NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_Local = @"LOCAL"; +NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_Nfs = @"NFS"; +NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_ObjectStore = @"OBJECT_STORE"; +NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_RecoveryAppliance = @"RECOVERY_APPLIANCE"; + // GTLROracleDatabase_CloudExadataInfrastructureProperties.computeModel NSString * const kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelEcpu = @"COMPUTE_MODEL_ECPU"; NSString * const kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelOcpu = @"COMPUTE_MODEL_OCPU"; @@ -210,6 +218,20 @@ NSString * const kGTLROracleDatabase_CloudVmClusterProperties_State_Terminating = @"TERMINATING"; NSString * const kGTLROracleDatabase_CloudVmClusterProperties_State_Updating = @"UPDATING"; +// GTLROracleDatabase_Database.opsInsightsStatus +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_Disabling = @"DISABLING"; +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_Enabled = @"ENABLED"; +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_Enabling = @"ENABLING"; +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_FailedDisabling = @"FAILED_DISABLING"; +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_FailedEnabling = @"FAILED_ENABLING"; +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_NotEnabled = @"NOT_ENABLED"; +NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_OperationsInsightsStatusUnspecified = @"OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED"; + +// GTLROracleDatabase_DatabaseCharacterSet.characterSetType +NSString * const kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_CharacterSetTypeUnspecified = @"CHARACTER_SET_TYPE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_Database = @"DATABASE"; +NSString * const kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_National = @"NATIONAL"; + // GTLROracleDatabase_DatabaseConnectionStringProfile.consumerGroup NSString * const kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_ConsumerGroupUnspecified = @"CONSUMER_GROUP_UNSPECIFIED"; NSString * const kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_High = @"HIGH"; @@ -244,6 +266,80 @@ NSString * const kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_Server = @"SERVER"; NSString * const kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_TlsAuthenticationUnspecified = @"TLS_AUTHENTICATION_UNSPECIFIED"; +// GTLROracleDatabase_DatabaseManagementConfig.managementState +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Disabled = @"DISABLED"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Disabling = @"DISABLING"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Enabled = @"ENABLED"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Enabling = @"ENABLING"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedDisabling = @"FAILED_DISABLING"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedEnabling = @"FAILED_ENABLING"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedUpdating = @"FAILED_UPDATING"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_ManagementStateUnspecified = @"MANAGEMENT_STATE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Updating = @"UPDATING"; + +// GTLROracleDatabase_DatabaseManagementConfig.managementType +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_Advanced = @"ADVANCED"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_Basic = @"BASIC"; +NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_ManagementTypeUnspecified = @"MANAGEMENT_TYPE_UNSPECIFIED"; + +// GTLROracleDatabase_DatabaseProperties.state +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Available = @"AVAILABLE"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_BackupInProgress = @"BACKUP_IN_PROGRESS"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Converting = @"CONVERTING"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_DatabaseLifecycleStateUnspecified = @"DATABASE_LIFECYCLE_STATE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Failed = @"FAILED"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Provisioning = @"PROVISIONING"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_RestoreFailed = @"RESTORE_FAILED"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Terminated = @"TERMINATED"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Terminating = @"TERMINATING"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Updating = @"UPDATING"; +NSString * const kGTLROracleDatabase_DatabaseProperties_State_Upgrading = @"UPGRADING"; + +// GTLROracleDatabase_DbBackupConfig.autoFullBackupDay +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_DayOfWeekUnspecified = @"DAY_OF_WEEK_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Friday = @"FRIDAY"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Monday = @"MONDAY"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Saturday = @"SATURDAY"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Sunday = @"SUNDAY"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Thursday = @"THURSDAY"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Tuesday = @"TUESDAY"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Wednesday = @"WEDNESDAY"; + +// GTLROracleDatabase_DbBackupConfig.autoFullBackupWindow +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_BackupWindowUnspecified = @"BACKUP_WINDOW_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotEight = @"SLOT_EIGHT"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotEleven = @"SLOT_ELEVEN"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotFive = @"SLOT_FIVE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotFour = @"SLOT_FOUR"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotNine = @"SLOT_NINE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotOne = @"SLOT_ONE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotSeven = @"SLOT_SEVEN"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotSix = @"SLOT_SIX"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTen = @"SLOT_TEN"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotThree = @"SLOT_THREE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTwelve = @"SLOT_TWELVE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTwo = @"SLOT_TWO"; + +// GTLROracleDatabase_DbBackupConfig.autoIncrementalBackupWindow +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_BackupWindowUnspecified = @"BACKUP_WINDOW_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotEight = @"SLOT_EIGHT"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotEleven = @"SLOT_ELEVEN"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotFive = @"SLOT_FIVE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotFour = @"SLOT_FOUR"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotNine = @"SLOT_NINE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotOne = @"SLOT_ONE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotSeven = @"SLOT_SEVEN"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotSix = @"SLOT_SIX"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTen = @"SLOT_TEN"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotThree = @"SLOT_THREE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTwelve = @"SLOT_TWELVE"; +NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTwo = @"SLOT_TWO"; + +// GTLROracleDatabase_DbBackupConfig.backupDeletionPolicy +NSString * const kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_BackupDeletionPolicyUnspecified = @"BACKUP_DELETION_POLICY_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_DeleteAfterRetentionPeriod = @"DELETE_AFTER_RETENTION_PERIOD"; +NSString * const kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_DeleteImmediately = @"DELETE_IMMEDIATELY"; + // GTLROracleDatabase_DbNodeProperties.state NSString * const kGTLROracleDatabase_DbNodeProperties_State_Available = @"AVAILABLE"; NSString * const kGTLROracleDatabase_DbNodeProperties_State_Failed = @"FAILED"; @@ -264,6 +360,54 @@ NSString * const kGTLROracleDatabase_DbServerProperties_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLROracleDatabase_DbServerProperties_State_Unavailable = @"UNAVAILABLE"; +// GTLROracleDatabase_DbSystemInitialStorageSizeProperties.shapeType +NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_ShapeType_ShapeTypeUnspecified = @"SHAPE_TYPE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_ShapeType_StandardX86 = @"STANDARD_X86"; + +// GTLROracleDatabase_DbSystemInitialStorageSizeProperties.storageManagement +NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_Asm = @"ASM"; +NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_Lvm = @"LVM"; +NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_StorageManagementUnspecified = @"STORAGE_MANAGEMENT_UNSPECIFIED"; + +// GTLROracleDatabase_DbSystemOptions.storageManagement +NSString * const kGTLROracleDatabase_DbSystemOptions_StorageManagement_Asm = @"ASM"; +NSString * const kGTLROracleDatabase_DbSystemOptions_StorageManagement_Lvm = @"LVM"; +NSString * const kGTLROracleDatabase_DbSystemOptions_StorageManagement_StorageManagementUnspecified = @"STORAGE_MANAGEMENT_UNSPECIFIED"; + +// GTLROracleDatabase_DbSystemProperties.computeModel +NSString * const kGTLROracleDatabase_DbSystemProperties_ComputeModel_ComputeModelUnspecified = @"COMPUTE_MODEL_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_ComputeModel_Ecpu = @"ECPU"; +NSString * const kGTLROracleDatabase_DbSystemProperties_ComputeModel_Ocpu = @"OCPU"; + +// GTLROracleDatabase_DbSystemProperties.databaseEdition +NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_DbSystemDatabaseEditionUnspecified = @"DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_EnterpriseEdition = @"ENTERPRISE_EDITION"; +NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_EnterpriseEditionHighPerformance = @"ENTERPRISE_EDITION_HIGH_PERFORMANCE"; +NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_StandardEdition = @"STANDARD_EDITION"; + +// GTLROracleDatabase_DbSystemProperties.licenseModel +NSString * const kGTLROracleDatabase_DbSystemProperties_LicenseModel_BringYourOwnLicense = @"BRING_YOUR_OWN_LICENSE"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LicenseModel_LicenseIncluded = @"LICENSE_INCLUDED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LicenseModel_LicenseModelUnspecified = @"LICENSE_MODEL_UNSPECIFIED"; + +// GTLROracleDatabase_DbSystemProperties.lifecycleState +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Available = @"AVAILABLE"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_DbSystemLifecycleStateUnspecified = @"DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Failed = @"FAILED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_MaintenanceInProgress = @"MAINTENANCE_IN_PROGRESS"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Migrated = @"MIGRATED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_NeedsAttention = @"NEEDS_ATTENTION"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Provisioning = @"PROVISIONING"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Terminated = @"TERMINATED"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Terminating = @"TERMINATING"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Updating = @"UPDATING"; +NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Upgrading = @"UPGRADING"; + +// GTLROracleDatabase_EncryptionKey.provider +NSString * const kGTLROracleDatabase_EncryptionKey_Provider_GoogleManaged = @"GOOGLE_MANAGED"; +NSString * const kGTLROracleDatabase_EncryptionKey_Provider_OracleManaged = @"ORACLE_MANAGED"; +NSString * const kGTLROracleDatabase_EncryptionKey_Provider_ProviderUnspecified = @"PROVIDER_UNSPECIFIED"; + // GTLROracleDatabase_Entitlement.state NSString * const kGTLROracleDatabase_Entitlement_State_AccountNotActive = @"ACCOUNT_NOT_ACTIVE"; NSString * const kGTLROracleDatabase_Entitlement_State_AccountNotLinked = @"ACCOUNT_NOT_LINKED"; @@ -272,6 +416,45 @@ NSString * const kGTLROracleDatabase_Entitlement_State_NotApprovedInPrivateMarketplace = @"NOT_APPROVED_IN_PRIVATE_MARKETPLACE"; NSString * const kGTLROracleDatabase_Entitlement_State_StateUnspecified = @"STATE_UNSPECIFIED"; +// GTLROracleDatabase_ExadbVmClusterProperties.licenseModel +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_BringYourOwnLicense = @"BRING_YOUR_OWN_LICENSE"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_LicenseIncluded = @"LICENSE_INCLUDED"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_LicenseModelUnspecified = @"LICENSE_MODEL_UNSPECIFIED"; + +// GTLROracleDatabase_ExadbVmClusterProperties.lifecycleState +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Available = @"AVAILABLE"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_ExadbVmClusterLifecycleStateUnspecified = @"EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Failed = @"FAILED"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_MaintenanceInProgress = @"MAINTENANCE_IN_PROGRESS"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Provisioning = @"PROVISIONING"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Terminated = @"TERMINATED"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Terminating = @"TERMINATING"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Updating = @"UPDATING"; + +// GTLROracleDatabase_ExadbVmClusterProperties.shapeAttribute +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_BlockStorage = @"BLOCK_STORAGE"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_ShapeAttributeUnspecified = @"SHAPE_ATTRIBUTE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_SmartStorage = @"SMART_STORAGE"; + +// GTLROracleDatabase_ExascaleDbStorageVaultProperties.attachedShapeAttributes +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AttachedShapeAttributes_BlockStorage = @"BLOCK_STORAGE"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AttachedShapeAttributes_ShapeAttributeUnspecified = @"SHAPE_ATTRIBUTE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AttachedShapeAttributes_SmartStorage = @"SMART_STORAGE"; + +// GTLROracleDatabase_ExascaleDbStorageVaultProperties.availableShapeAttributes +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AvailableShapeAttributes_BlockStorage = @"BLOCK_STORAGE"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AvailableShapeAttributes_ShapeAttributeUnspecified = @"SHAPE_ATTRIBUTE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AvailableShapeAttributes_SmartStorage = @"SMART_STORAGE"; + +// GTLROracleDatabase_ExascaleDbStorageVaultProperties.state +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Available = @"AVAILABLE"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Failed = @"FAILED"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Provisioning = @"PROVISIONING"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_StateUnspecified = @"STATE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Terminated = @"TERMINATED"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Terminating = @"TERMINATING"; +NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Updating = @"UPDATING"; + // GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest.type NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_All = @"ALL"; NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_GenerateTypeUnspecified = @"GENERATE_TYPE_UNSPECIFIED"; @@ -338,6 +521,38 @@ NSString * const kGTLROracleDatabase_OdbSubnet_State_StateUnspecified = @"STATE_UNSPECIFIED"; NSString * const kGTLROracleDatabase_OdbSubnet_State_Terminating = @"TERMINATING"; +// GTLROracleDatabase_PluggableDatabaseNodeLevelDetails.openMode +NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_Migrate = @"MIGRATE"; +NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_Mounted = @"MOUNTED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_PluggableDatabaseOpenModeUnspecified = @"PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_ReadOnly = @"READ_ONLY"; +NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_ReadWrite = @"READ_WRITE"; + +// GTLROracleDatabase_PluggableDatabaseProperties.lifecycleState +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Available = @"AVAILABLE"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_BackupInProgress = @"BACKUP_IN_PROGRESS"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Disabled = @"DISABLED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Failed = @"FAILED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_PluggableDatabaseLifecycleStateUnspecified = @"PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Provisioning = @"PROVISIONING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Refreshing = @"REFRESHING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Relocated = @"RELOCATED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Relocating = @"RELOCATING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_RestoreFailed = @"RESTORE_FAILED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_RestoreInProgress = @"RESTORE_IN_PROGRESS"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Terminated = @"TERMINATED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Terminating = @"TERMINATING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Updating = @"UPDATING"; + +// GTLROracleDatabase_PluggableDatabaseProperties.operationsInsightsState +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Disabling = @"DISABLING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Enabled = @"ENABLED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Enabling = @"ENABLING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_FailedDisabling = @"FAILED_DISABLING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_FailedEnabling = @"FAILED_ENABLING"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_NotEnabled = @"NOT_ENABLED"; +NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_OperationsInsightsStateUnspecified = @"OPERATIONS_INSIGHTS_STATE_UNSPECIFIED"; + // GTLROracleDatabase_ScheduledOperationDetails.dayOfWeek NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_DayOfWeekUnspecified = @"DAY_OF_WEEK_UNSPECIFIED"; NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Friday = @"FRIDAY"; @@ -495,7 +710,8 @@ @implementation GTLROracleDatabase_AutonomousDatabaseProperties connectionStrings, connectionUrls, cpuCoreCount, customerContacts, databaseManagementState, dataGuardRoleChangedTime, dataSafeState, dataStorageSizeGb, dataStorageSizeTb, dbEdition, dbVersion, dbWorkload, - disasterRecoveryRoleChangedTime, failedDataRecoveryDuration, + disasterRecoveryRoleChangedTime, encryptionKey, + encryptionKeyHistoryEntries, failedDataRecoveryDuration, isAutoScalingEnabled, isLocalDataGuardEnabled, isStorageAutoScalingEnabled, licenseType, lifecycleDetails, localAdgAutoFailoverMaxDataLossLimit, localDisasterRecoveryType, @@ -505,14 +721,16 @@ @implementation GTLROracleDatabase_AutonomousDatabaseProperties ociUrl, openMode, operationsInsightsState, peerDbIds, permissionLevel, privateEndpoint, privateEndpointIp, privateEndpointLabel, refreshableMode, refreshableState, role, scheduledOperationDetails, - secretId, sqlWebDeveloperUrl, state, supportedCloneRegions, - totalAutoBackupStorageSizeGbs, usedDataStorageSizeTbs, vaultId; + secretId, serviceAgentEmail, sqlWebDeveloperUrl, state, + supportedCloneRegions, totalAutoBackupStorageSizeGbs, + usedDataStorageSizeTbs, vaultId; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @"allowlistedIps" : [NSString class], @"availableUpgradeVersions" : [NSString class], @"customerContacts" : [GTLROracleDatabase_CustomerContact class], + @"encryptionKeyHistoryEntries" : [GTLROracleDatabase_EncryptionKeyHistoryEntry class], @"peerDbIds" : [NSString class], @"scheduledOperationDetails" : [GTLROracleDatabase_ScheduledOperationDetails class], @"supportedCloneRegions" : [NSString class] @@ -544,6 +762,16 @@ @implementation GTLROracleDatabase_AutonomousDbVersion @end +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_BackupDestinationDetails +// + +@implementation GTLROracleDatabase_BackupDestinationDetails +@dynamic type; +@end + + // ---------------------------------------------------------------------------- // // GTLROracleDatabase_CancelOperationRequest @@ -681,209 +909,189 @@ @implementation GTLROracleDatabase_CustomerContact // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DatabaseConnectionStringProfile +// GTLROracleDatabase_Database // -@implementation GTLROracleDatabase_DatabaseConnectionStringProfile -@dynamic consumerGroup, displayName, hostFormat, isRegional, protocol, - sessionMode, syntaxFormat, tlsAuthentication, value; +@implementation GTLROracleDatabase_Database +@dynamic adminPassword, characterSet, createTime, databaseId, dbHomeName, + dbName, dbUniqueName, gcpOracleZone, name, ncharacterSet, ociUrl, + opsInsightsStatus, properties, tdeWalletPassword; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DataCollectionOptions +// GTLROracleDatabase_DatabaseCharacterSet // -@implementation GTLROracleDatabase_DataCollectionOptions -@dynamic diagnosticsEventsEnabled, healthMonitoringEnabled, incidentLogsEnabled; +@implementation GTLROracleDatabase_DatabaseCharacterSet +@dynamic characterSet, characterSetType, name; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DbNode +// GTLROracleDatabase_DatabaseConnectionStringProfile // -@implementation GTLROracleDatabase_DbNode -@dynamic name, properties; +@implementation GTLROracleDatabase_DatabaseConnectionStringProfile +@dynamic consumerGroup, displayName, hostFormat, isRegional, protocol, + sessionMode, syntaxFormat, tlsAuthentication, value; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DbNodeProperties +// GTLROracleDatabase_DatabaseManagementConfig // -@implementation GTLROracleDatabase_DbNodeProperties -@dynamic createTime, dbNodeStorageSizeGb, dbServerOcid, hostname, memorySizeGb, - ocid, ocpuCount, state, totalCpuCoreCount; +@implementation GTLROracleDatabase_DatabaseManagementConfig +@dynamic managementState, managementType; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DbServer +// GTLROracleDatabase_DatabaseProperties // -@implementation GTLROracleDatabase_DbServer -@dynamic displayName, name, properties; +@implementation GTLROracleDatabase_DatabaseProperties +@dynamic databaseManagementConfig, dbBackupConfig, dbVersion, state; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DbServerProperties +// GTLROracleDatabase_DataCollectionOptions // -@implementation GTLROracleDatabase_DbServerProperties -@dynamic dbNodeIds, dbNodeStorageSizeGb, maxDbNodeStorageSizeGb, - maxMemorySizeGb, maxOcpuCount, memorySizeGb, ocid, ocpuCount, state, - vmCount; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"dbNodeIds" : [NSString class] - }; - return map; -} - +@implementation GTLROracleDatabase_DataCollectionOptions +@dynamic diagnosticsEventsEnabled, healthMonitoringEnabled, incidentLogsEnabled; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_DbSystemShape +// GTLROracleDatabase_DataCollectionOptionsCommon // -@implementation GTLROracleDatabase_DbSystemShape -@dynamic availableCoreCountPerNode, availableDataStorageTb, - availableMemoryPerNodeGb, maxNodeCount, maxStorageCount, - minCoreCountPerNode, minDbNodeStoragePerNodeGb, minMemoryPerNodeGb, - minNodeCount, minStorageCount, name, shape; +@implementation GTLROracleDatabase_DataCollectionOptionsCommon +@dynamic isDiagnosticsEventsEnabled, isHealthMonitoringEnabled, + isIncidentLogsEnabled; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_Empty +// GTLROracleDatabase_DataCollectionOptionsDbSystem // -@implementation GTLROracleDatabase_Empty +@implementation GTLROracleDatabase_DataCollectionOptionsDbSystem +@dynamic isDiagnosticsEventsEnabled, isIncidentLogsEnabled; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_Entitlement +// GTLROracleDatabase_DbBackupConfig // -@implementation GTLROracleDatabase_Entitlement -@dynamic cloudAccountDetails, entitlementId, name, state; +@implementation GTLROracleDatabase_DbBackupConfig +@dynamic autoBackupEnabled, autoFullBackupDay, autoFullBackupWindow, + autoIncrementalBackupWindow, backupDeletionPolicy, + backupDestinationDetails, retentionPeriodDays; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"backupDestinationDetails" : [GTLROracleDatabase_BackupDestinationDetails class] + }; + return map; +} + @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest +// GTLROracleDatabase_DbHome // -@implementation GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest -@dynamic isRegional, password, type; +@implementation GTLROracleDatabase_DbHome +@dynamic database, dbVersion, displayName, isUnifiedAuditingEnabled; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_GenerateAutonomousDatabaseWalletResponse +// GTLROracleDatabase_DbNode // -@implementation GTLROracleDatabase_GenerateAutonomousDatabaseWalletResponse -@dynamic archiveContent; +@implementation GTLROracleDatabase_DbNode +@dynamic name, properties; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_GiVersion +// GTLROracleDatabase_DbNodeProperties // -@implementation GTLROracleDatabase_GiVersion -@dynamic name, version; +@implementation GTLROracleDatabase_DbNodeProperties +@dynamic createTime, dbNodeStorageSizeGb, dbServerOcid, hostname, memorySizeGb, + ocid, ocpuCount, state, totalCpuCoreCount; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_IdentityConnector +// GTLROracleDatabase_DbServer // -@implementation GTLROracleDatabase_IdentityConnector -@dynamic connectionState, serviceAgentEmail; +@implementation GTLROracleDatabase_DbServer +@dynamic displayName, name, properties; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListAutonomousDatabaseBackupsResponse +// GTLROracleDatabase_DbServerProperties // -@implementation GTLROracleDatabase_ListAutonomousDatabaseBackupsResponse -@dynamic autonomousDatabaseBackups, nextPageToken; +@implementation GTLROracleDatabase_DbServerProperties +@dynamic dbNodeIds, dbNodeStorageSizeGb, maxDbNodeStorageSizeGb, + maxMemorySizeGb, maxOcpuCount, memorySizeGb, ocid, ocpuCount, state, + vmCount; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"autonomousDatabaseBackups" : [GTLROracleDatabase_AutonomousDatabaseBackup class] + @"dbNodeIds" : [NSString class] }; return map; } -+ (NSString *)collectionItemsKey { - return @"autonomousDatabaseBackups"; -} - @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListAutonomousDatabaseCharacterSetsResponse +// GTLROracleDatabase_DbSystem // -@implementation GTLROracleDatabase_ListAutonomousDatabaseCharacterSetsResponse -@dynamic autonomousDatabaseCharacterSets, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"autonomousDatabaseCharacterSets" : [GTLROracleDatabase_AutonomousDatabaseCharacterSet class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"autonomousDatabaseCharacterSets"; -} - +@implementation GTLROracleDatabase_DbSystem +@dynamic createTime, displayName, entitlementId, gcpOracleZone, labels, name, + ociUrl, odbNetwork, odbSubnet, properties; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListAutonomousDatabasesResponse +// GTLROracleDatabase_DbSystem_Labels // -@implementation GTLROracleDatabase_ListAutonomousDatabasesResponse -@dynamic autonomousDatabases, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"autonomousDatabases" : [GTLROracleDatabase_AutonomousDatabase class] - }; - return map; -} +@implementation GTLROracleDatabase_DbSystem_Labels -+ (NSString *)collectionItemsKey { - return @"autonomousDatabases"; ++ (Class)classForAdditionalProperties { + return [NSString class]; } @end @@ -891,153 +1099,119 @@ + (NSString *)collectionItemsKey { // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListAutonomousDbVersionsResponse +// GTLROracleDatabase_DbSystemInitialStorageSize // -@implementation GTLROracleDatabase_ListAutonomousDbVersionsResponse -@dynamic autonomousDbVersions, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"autonomousDbVersions" : [GTLROracleDatabase_AutonomousDbVersion class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"autonomousDbVersions"; -} - +@implementation GTLROracleDatabase_DbSystemInitialStorageSize +@dynamic name, properties; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListCloudExadataInfrastructuresResponse +// GTLROracleDatabase_DbSystemInitialStorageSizeProperties // -@implementation GTLROracleDatabase_ListCloudExadataInfrastructuresResponse -@dynamic cloudExadataInfrastructures, nextPageToken; +@implementation GTLROracleDatabase_DbSystemInitialStorageSizeProperties +@dynamic launchFromBackupStorageSizeDetails, shapeType, storageManagement, + storageSizeDetails; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"cloudExadataInfrastructures" : [GTLROracleDatabase_CloudExadataInfrastructure class] + @"launchFromBackupStorageSizeDetails" : [GTLROracleDatabase_StorageSizeDetails class], + @"storageSizeDetails" : [GTLROracleDatabase_StorageSizeDetails class] }; return map; } -+ (NSString *)collectionItemsKey { - return @"cloudExadataInfrastructures"; -} - @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListCloudVmClustersResponse +// GTLROracleDatabase_DbSystemOptions // -@implementation GTLROracleDatabase_ListCloudVmClustersResponse -@dynamic cloudVmClusters, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"cloudVmClusters" : [GTLROracleDatabase_CloudVmCluster class] - }; - return map; -} - -+ (NSString *)collectionItemsKey { - return @"cloudVmClusters"; -} - +@implementation GTLROracleDatabase_DbSystemOptions +@dynamic storageManagement; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListDbNodesResponse +// GTLROracleDatabase_DbSystemProperties // -@implementation GTLROracleDatabase_ListDbNodesResponse -@dynamic dbNodes, nextPageToken; +@implementation GTLROracleDatabase_DbSystemProperties +@dynamic computeCount, computeModel, databaseEdition, dataCollectionOptions, + dataStorageSizeGb, dbHome, dbSystemOptions, domain, hostname, + hostnamePrefix, initialDataStorageSizeGb, licenseModel, lifecycleState, + memorySizeGb, nodeCount, ocid, privateIp, recoStorageSizeGb, shape, + sshPublicKeys, timeZone; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"dbNodes" : [GTLROracleDatabase_DbNode class] + @"sshPublicKeys" : [NSString class] }; return map; } -+ (NSString *)collectionItemsKey { - return @"dbNodes"; -} - @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListDbServersResponse +// GTLROracleDatabase_DbSystemShape // -@implementation GTLROracleDatabase_ListDbServersResponse -@dynamic dbServers, nextPageToken; +@implementation GTLROracleDatabase_DbSystemShape +@dynamic availableCoreCountPerNode, availableDataStorageTb, + availableMemoryPerNodeGb, maxNodeCount, maxStorageCount, + minCoreCountPerNode, minDbNodeStoragePerNodeGb, minMemoryPerNodeGb, + minNodeCount, minStorageCount, name, shape; +@end -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"dbServers" : [GTLROracleDatabase_DbServer class] - }; - return map; -} -+ (NSString *)collectionItemsKey { - return @"dbServers"; -} +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_DbVersion +// +@implementation GTLROracleDatabase_DbVersion +@dynamic name, properties; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListDbSystemShapesResponse +// GTLROracleDatabase_DbVersionProperties // -@implementation GTLROracleDatabase_ListDbSystemShapesResponse -@dynamic dbSystemShapes, nextPageToken; +@implementation GTLROracleDatabase_DbVersionProperties +@dynamic isLatestForMajorVersion, isPreviewDbVersion, isUpgradeSupported, + supportsPdb, version; +@end -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"dbSystemShapes" : [GTLROracleDatabase_DbSystemShape class] - }; - return map; -} -+ (NSString *)collectionItemsKey { - return @"dbSystemShapes"; -} +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_DefinedTagValue +// +@implementation GTLROracleDatabase_DefinedTagValue +@dynamic tags; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListEntitlementsResponse +// GTLROracleDatabase_DefinedTagValue_Tags // -@implementation GTLROracleDatabase_ListEntitlementsResponse -@dynamic entitlements, nextPageToken; - -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"entitlements" : [GTLROracleDatabase_Entitlement class] - }; - return map; -} +@implementation GTLROracleDatabase_DefinedTagValue_Tags -+ (NSString *)collectionItemsKey { - return @"entitlements"; ++ (Class)classForAdditionalProperties { + return [NSString class]; } @end @@ -1045,29 +1219,611 @@ + (NSString *)collectionItemsKey { // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListGiVersionsResponse +// GTLROracleDatabase_Empty // -@implementation GTLROracleDatabase_ListGiVersionsResponse -@dynamic giVersions, nextPageToken; +@implementation GTLROracleDatabase_Empty +@end -+ (NSDictionary *)arrayPropertyToClassMap { - NSDictionary *map = @{ - @"giVersions" : [GTLROracleDatabase_GiVersion class] - }; - return map; -} -+ (NSString *)collectionItemsKey { - return @"giVersions"; -} +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_EncryptionKey +// +@implementation GTLROracleDatabase_EncryptionKey +@dynamic kmsKey, provider; @end // ---------------------------------------------------------------------------- // -// GTLROracleDatabase_ListLocationsResponse +// GTLROracleDatabase_EncryptionKeyHistoryEntry +// + +@implementation GTLROracleDatabase_EncryptionKeyHistoryEntry +@dynamic activationTime, encryptionKey; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_Entitlement +// + +@implementation GTLROracleDatabase_Entitlement +@dynamic cloudAccountDetails, entitlementId, name, state; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExadbVmCluster +// + +@implementation GTLROracleDatabase_ExadbVmCluster +@dynamic backupOdbSubnet, createTime, displayName, entitlementId, gcpOracleZone, + labels, name, odbNetwork, odbSubnet, properties; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExadbVmCluster_Labels +// + +@implementation GTLROracleDatabase_ExadbVmCluster_Labels + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExadbVmClusterProperties +// + +@implementation GTLROracleDatabase_ExadbVmClusterProperties +@dynamic additionalEcpuCountPerNode, clusterName, dataCollectionOptions, + enabledEcpuCountPerNode, exascaleDbStorageVault, giVersion, + gridImageId, hostname, hostnamePrefix, licenseModel, lifecycleState, + memorySizeGb, nodeCount, ociUri, scanListenerPortTcp, shapeAttribute, + sshPublicKeys, timeZone, vmFileSystemStorage; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"sshPublicKeys" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExadbVmClusterStorageDetails +// + +@implementation GTLROracleDatabase_ExadbVmClusterStorageDetails +@dynamic sizeInGbsPerNode; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExascaleDbStorageDetails +// + +@implementation GTLROracleDatabase_ExascaleDbStorageDetails +@dynamic availableSizeGbs, totalSizeGbs; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExascaleDbStorageVault +// + +@implementation GTLROracleDatabase_ExascaleDbStorageVault +@dynamic createTime, displayName, entitlementId, gcpOracleZone, labels, name, + properties; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExascaleDbStorageVault_Labels +// + +@implementation GTLROracleDatabase_ExascaleDbStorageVault_Labels + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ExascaleDbStorageVaultProperties +// + +@implementation GTLROracleDatabase_ExascaleDbStorageVaultProperties +@dynamic additionalFlashCachePercent, attachedShapeAttributes, + availableShapeAttributes, descriptionProperty, + exascaleDbStorageDetails, ocid, ociUri, state, timeZone, + vmClusterCount, vmClusterIds; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"descriptionProperty" : @"description" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"attachedShapeAttributes" : [NSString class], + @"availableShapeAttributes" : [NSString class], + @"vmClusterIds" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_FailoverAutonomousDatabaseRequest +// + +@implementation GTLROracleDatabase_FailoverAutonomousDatabaseRequest +@dynamic peerAutonomousDatabase; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest +// + +@implementation GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest +@dynamic isRegional, password, type; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_GenerateAutonomousDatabaseWalletResponse +// + +@implementation GTLROracleDatabase_GenerateAutonomousDatabaseWalletResponse +@dynamic archiveContent; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_GiVersion +// + +@implementation GTLROracleDatabase_GiVersion +@dynamic name, version; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_IdentityConnector +// + +@implementation GTLROracleDatabase_IdentityConnector +@dynamic connectionState, serviceAgentEmail; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListAutonomousDatabaseBackupsResponse +// + +@implementation GTLROracleDatabase_ListAutonomousDatabaseBackupsResponse +@dynamic autonomousDatabaseBackups, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"autonomousDatabaseBackups" : [GTLROracleDatabase_AutonomousDatabaseBackup class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"autonomousDatabaseBackups"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListAutonomousDatabaseCharacterSetsResponse +// + +@implementation GTLROracleDatabase_ListAutonomousDatabaseCharacterSetsResponse +@dynamic autonomousDatabaseCharacterSets, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"autonomousDatabaseCharacterSets" : [GTLROracleDatabase_AutonomousDatabaseCharacterSet class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"autonomousDatabaseCharacterSets"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListAutonomousDatabasesResponse +// + +@implementation GTLROracleDatabase_ListAutonomousDatabasesResponse +@dynamic autonomousDatabases, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"autonomousDatabases" : [GTLROracleDatabase_AutonomousDatabase class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"autonomousDatabases"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListAutonomousDbVersionsResponse +// + +@implementation GTLROracleDatabase_ListAutonomousDbVersionsResponse +@dynamic autonomousDbVersions, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"autonomousDbVersions" : [GTLROracleDatabase_AutonomousDbVersion class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"autonomousDbVersions"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListCloudExadataInfrastructuresResponse +// + +@implementation GTLROracleDatabase_ListCloudExadataInfrastructuresResponse +@dynamic cloudExadataInfrastructures, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"cloudExadataInfrastructures" : [GTLROracleDatabase_CloudExadataInfrastructure class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"cloudExadataInfrastructures"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListCloudVmClustersResponse +// + +@implementation GTLROracleDatabase_ListCloudVmClustersResponse +@dynamic cloudVmClusters, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"cloudVmClusters" : [GTLROracleDatabase_CloudVmCluster class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"cloudVmClusters"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDatabaseCharacterSetsResponse +// + +@implementation GTLROracleDatabase_ListDatabaseCharacterSetsResponse +@dynamic databaseCharacterSets, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"databaseCharacterSets" : [GTLROracleDatabase_DatabaseCharacterSet class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"databaseCharacterSets"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDatabasesResponse +// + +@implementation GTLROracleDatabase_ListDatabasesResponse +@dynamic databases, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"databases" : [GTLROracleDatabase_Database class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"databases"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDbNodesResponse +// + +@implementation GTLROracleDatabase_ListDbNodesResponse +@dynamic dbNodes, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"dbNodes" : [GTLROracleDatabase_DbNode class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"dbNodes"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDbServersResponse +// + +@implementation GTLROracleDatabase_ListDbServersResponse +@dynamic dbServers, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"dbServers" : [GTLROracleDatabase_DbServer class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"dbServers"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDbSystemInitialStorageSizesResponse +// + +@implementation GTLROracleDatabase_ListDbSystemInitialStorageSizesResponse +@dynamic dbSystemInitialStorageSizes, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"dbSystemInitialStorageSizes" : [GTLROracleDatabase_DbSystemInitialStorageSize class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"dbSystemInitialStorageSizes"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDbSystemShapesResponse +// + +@implementation GTLROracleDatabase_ListDbSystemShapesResponse +@dynamic dbSystemShapes, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"dbSystemShapes" : [GTLROracleDatabase_DbSystemShape class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"dbSystemShapes"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDbSystemsResponse +// + +@implementation GTLROracleDatabase_ListDbSystemsResponse +@dynamic dbSystems, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"dbSystems" : [GTLROracleDatabase_DbSystem class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"dbSystems"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListDbVersionsResponse +// + +@implementation GTLROracleDatabase_ListDbVersionsResponse +@dynamic dbVersions, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"dbVersions" : [GTLROracleDatabase_DbVersion class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"dbVersions"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListEntitlementsResponse +// + +@implementation GTLROracleDatabase_ListEntitlementsResponse +@dynamic entitlements, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"entitlements" : [GTLROracleDatabase_Entitlement class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"entitlements"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListExadbVmClustersResponse +// + +@implementation GTLROracleDatabase_ListExadbVmClustersResponse +@dynamic exadbVmClusters, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"exadbVmClusters" : [GTLROracleDatabase_ExadbVmCluster class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"exadbVmClusters"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListExascaleDbStorageVaultsResponse +// + +@implementation GTLROracleDatabase_ListExascaleDbStorageVaultsResponse +@dynamic exascaleDbStorageVaults, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"exascaleDbStorageVaults" : [GTLROracleDatabase_ExascaleDbStorageVault class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"exascaleDbStorageVaults"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListGiVersionsResponse +// + +@implementation GTLROracleDatabase_ListGiVersionsResponse +@dynamic giVersions, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"giVersions" : [GTLROracleDatabase_GiVersion class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"giVersions"; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListLocationsResponse // @implementation GTLROracleDatabase_ListLocationsResponse @@ -1087,6 +1843,28 @@ + (NSString *)collectionItemsKey { @end +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListMinorVersionsResponse +// + +@implementation GTLROracleDatabase_ListMinorVersionsResponse +@dynamic minorVersions, nextPageToken; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"minorVersions" : [GTLROracleDatabase_MinorVersion class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"minorVersions"; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLROracleDatabase_ListOdbNetworksResponse @@ -1139,11 +1917,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLROracleDatabase_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLROracleDatabase_Operation class] + @"operations" : [GTLROracleDatabase_Operation class], + @"unreachable" : [NSString class] }; return map; } @@ -1155,6 +1934,28 @@ + (NSString *)collectionItemsKey { @end +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_ListPluggableDatabasesResponse +// + +@implementation GTLROracleDatabase_ListPluggableDatabasesResponse +@dynamic nextPageToken, pluggableDatabases; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"pluggableDatabases" : [GTLROracleDatabase_PluggableDatabase class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"pluggableDatabases"; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLROracleDatabase_Location @@ -1234,13 +2035,23 @@ @implementation GTLROracleDatabase_MaintenanceWindow @end +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_MinorVersion +// + +@implementation GTLROracleDatabase_MinorVersion +@dynamic gridImageId, name, version; +@end + + // ---------------------------------------------------------------------------- // // GTLROracleDatabase_OdbNetwork // @implementation GTLROracleDatabase_OdbNetwork -@dynamic createTime, entitlementId, labels, name, network, state; +@dynamic createTime, entitlementId, gcpOracleZone, labels, name, network, state; @end @@ -1331,6 +2142,117 @@ @implementation GTLROracleDatabase_OperationMetadata @end +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabase +// + +@implementation GTLROracleDatabase_PluggableDatabase +@dynamic createTime, name, ociUrl, properties; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabaseConnectionStrings +// + +@implementation GTLROracleDatabase_PluggableDatabaseConnectionStrings +@dynamic allConnectionStrings, pdbDefault, pdbIpDefault; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabaseConnectionStrings_AllConnectionStrings +// + +@implementation GTLROracleDatabase_PluggableDatabaseConnectionStrings_AllConnectionStrings + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabaseNodeLevelDetails +// + +@implementation GTLROracleDatabase_PluggableDatabaseNodeLevelDetails +@dynamic nodeName, openMode, pluggableDatabaseId; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabaseProperties +// + +@implementation GTLROracleDatabase_PluggableDatabaseProperties +@dynamic compartmentId, connectionStrings, containerDatabaseOcid, + databaseManagementConfig, definedTags, freeformTags, isRestricted, + lifecycleDetails, lifecycleState, ocid, operationsInsightsState, + pdbName, pdbNodeLevelDetails; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"pdbNodeLevelDetails" : [GTLROracleDatabase_PluggableDatabaseNodeLevelDetails class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabaseProperties_DefinedTags +// + +@implementation GTLROracleDatabase_PluggableDatabaseProperties_DefinedTags + ++ (Class)classForAdditionalProperties { + return [GTLROracleDatabase_DefinedTagValue class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_PluggableDatabaseProperties_FreeformTags +// + +@implementation GTLROracleDatabase_PluggableDatabaseProperties_FreeformTags + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_RemoveVirtualMachineExadbVmClusterRequest +// + +@implementation GTLROracleDatabase_RemoveVirtualMachineExadbVmClusterRequest +@dynamic hostnames, requestId; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"hostnames" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLROracleDatabase_RestartAutonomousDatabaseRequest @@ -1420,6 +2342,16 @@ @implementation GTLROracleDatabase_StopAutonomousDatabaseRequest @end +// ---------------------------------------------------------------------------- +// +// GTLROracleDatabase_StorageSizeDetails +// + +@implementation GTLROracleDatabase_StorageSizeDetails +@dynamic dataStorageSizeInGbs, recoStorageSizeInGbs; +@end + + // ---------------------------------------------------------------------------- // // GTLROracleDatabase_SwitchoverAutonomousDatabaseRequest diff --git a/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseQuery.m b/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseQuery.m index 3c011991a..0f69a5dec 100644 --- a/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseQuery.m +++ b/Sources/GeneratedServices/OracleDatabase/GTLROracleDatabaseQuery.m @@ -101,6 +101,33 @@ + (instancetype)queryWithName:(NSString *)name { @end +@implementation GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesFailover + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_FailoverAutonomousDatabaseRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:failover"; + GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesFailover *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.autonomousDatabases.failover"; + return query; +} + +@end + @implementation GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesGenerateWallet @dynamic name; @@ -166,6 +193,33 @@ + (instancetype)queryWithParent:(NSString *)parent { @end +@implementation GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesPatch + +@dynamic name, requestId, updateMask; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_AutonomousDatabase *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.autonomousDatabases.patch"; + return query; +} + +@end + @implementation GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesRestart @dynamic name; @@ -406,7 +460,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLROracleDatabaseQuery_ProjectsLocationsCloudExadataInfrastructuresList -@dynamic pageSize, pageToken, parent; +@dynamic filter, orderBy, pageSize, pageToken, parent; + (instancetype)queryWithParent:(NSString *)parent { NSArray *pathParams = @[ @"parent" ]; @@ -526,10 +580,151 @@ + (instancetype)queryWithParent:(NSString *)parent { @end -@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemShapesList +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDatabaseCharacterSetsList + +@dynamic filter, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/databaseCharacterSets"; + GTLROracleDatabaseQuery_ProjectsLocationsDatabaseCharacterSetsList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListDatabaseCharacterSetsResponse class]; + query.loggingName = @"oracledatabase.projects.locations.databaseCharacterSets.list"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDatabasesGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsDatabasesGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Database class]; + query.loggingName = @"oracledatabase.projects.locations.databases.get"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDatabasesList + +@dynamic filter, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/databases"; + GTLROracleDatabaseQuery_ProjectsLocationsDatabasesList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListDatabasesResponse class]; + query.loggingName = @"oracledatabase.projects.locations.databases.list"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemInitialStorageSizesList @dynamic pageSize, pageToken, parent; ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/dbSystemInitialStorageSizes"; + GTLROracleDatabaseQuery_ProjectsLocationsDbSystemInitialStorageSizesList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListDbSystemInitialStorageSizesResponse class]; + query.loggingName = @"oracledatabase.projects.locations.dbSystemInitialStorageSizes.list"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsCreate + +@dynamic dbSystemId, parent, requestId; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_DbSystem *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/dbSystems"; + GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsCreate *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.dbSystems.create"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsDelete + +@dynamic name, requestId; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.dbSystems.delete"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_DbSystem class]; + query.loggingName = @"oracledatabase.projects.locations.dbSystems.get"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemShapesList + +@dynamic filter, pageSize, pageToken, parent; + + (instancetype)queryWithParent:(NSString *)parent { NSArray *pathParams = @[ @"parent" ]; NSString *pathURITemplate = @"v1/{+parent}/dbSystemShapes"; @@ -545,6 +740,44 @@ + (instancetype)queryWithParent:(NSString *)parent { @end +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsList + +@dynamic filter, orderBy, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/dbSystems"; + GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListDbSystemsResponse class]; + query.loggingName = @"oracledatabase.projects.locations.dbSystems.list"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsDbVersionsList + +@dynamic filter, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/dbVersions"; + GTLROracleDatabaseQuery_ProjectsLocationsDbVersionsList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListDbVersionsResponse class]; + query.loggingName = @"oracledatabase.projects.locations.dbVersions.list"; + return query; +} + +@end + @implementation GTLROracleDatabaseQuery_ProjectsLocationsEntitlementsList @dynamic pageSize, pageToken, parent; @@ -564,6 +797,228 @@ + (instancetype)queryWithParent:(NSString *)parent { @end +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersCreate + +@dynamic exadbVmClusterId, parent, requestId; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_ExadbVmCluster *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/exadbVmClusters"; + GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersCreate *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.exadbVmClusters.create"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersDelete + +@dynamic name, requestId; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.exadbVmClusters.delete"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_ExadbVmCluster class]; + query.loggingName = @"oracledatabase.projects.locations.exadbVmClusters.get"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersList + +@dynamic filter, orderBy, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/exadbVmClusters"; + GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListExadbVmClustersResponse class]; + query.loggingName = @"oracledatabase.projects.locations.exadbVmClusters.list"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersPatch + +@dynamic name, requestId, updateMask; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_ExadbVmCluster *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.exadbVmClusters.patch"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersRemoveVirtualMachine + +@dynamic name; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_RemoveVirtualMachineExadbVmClusterRequest *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}:removeVirtualMachine"; + GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersRemoveVirtualMachine *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsCreate + +@dynamic exascaleDbStorageVaultId, parent, requestId; + ++ (instancetype)queryWithObject:(GTLROracleDatabase_ExascaleDbStorageVault *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/exascaleDbStorageVaults"; + GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsCreate *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.exascaleDbStorageVaults.create"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsDelete + +@dynamic name, requestId; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_Operation class]; + query.loggingName = @"oracledatabase.projects.locations.exascaleDbStorageVaults.delete"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_ExascaleDbStorageVault class]; + query.loggingName = @"oracledatabase.projects.locations.exascaleDbStorageVaults.get"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsList + +@dynamic filter, orderBy, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/exascaleDbStorageVaults"; + GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListExascaleDbStorageVaultsResponse class]; + query.loggingName = @"oracledatabase.projects.locations.exascaleDbStorageVaults.list"; + return query; +} + +@end + @implementation GTLROracleDatabaseQuery_ProjectsLocationsGet @dynamic name; @@ -602,6 +1057,25 @@ + (instancetype)queryWithParent:(NSString *)parent { @end +@implementation GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsMinorVersionsList + +@dynamic filter, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/minorVersions"; + GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsMinorVersionsList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListMinorVersionsResponse class]; + query.loggingName = @"oracledatabase.projects.locations.giVersions.minorVersions.list"; + return query; +} + +@end + @implementation GTLROracleDatabaseQuery_ProjectsLocationsList @dynamic extraLocationTypes, filter, name, pageSize, pageToken; @@ -863,7 +1337,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLROracleDatabaseQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; @@ -879,3 +1353,41 @@ + (instancetype)queryWithName:(NSString *)name { } @end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLROracleDatabase_PluggableDatabase class]; + query.loggingName = @"oracledatabase.projects.locations.pluggableDatabases.get"; + return query; +} + +@end + +@implementation GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesList + +@dynamic filter, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1/{+parent}/pluggableDatabases"; + GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLROracleDatabase_ListPluggableDatabasesResponse class]; + query.loggingName = @"oracledatabase.projects.locations.pluggableDatabases.list"; + return query; +} + +@end diff --git a/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseObjects.h b/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseObjects.h index 6b4c14213..e711e7112 100644 --- a/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseObjects.h +++ b/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseObjects.h @@ -28,6 +28,7 @@ @class GTLROracleDatabase_AutonomousDatabaseProperties; @class GTLROracleDatabase_AutonomousDatabaseStandbySummary; @class GTLROracleDatabase_AutonomousDbVersion; +@class GTLROracleDatabase_BackupDestinationDetails; @class GTLROracleDatabase_CloudAccountDetails; @class GTLROracleDatabase_CloudExadataInfrastructure; @class GTLROracleDatabase_CloudExadataInfrastructure_Labels; @@ -36,20 +37,49 @@ @class GTLROracleDatabase_CloudVmCluster_Labels; @class GTLROracleDatabase_CloudVmClusterProperties; @class GTLROracleDatabase_CustomerContact; +@class GTLROracleDatabase_Database; +@class GTLROracleDatabase_DatabaseCharacterSet; @class GTLROracleDatabase_DatabaseConnectionStringProfile; +@class GTLROracleDatabase_DatabaseManagementConfig; +@class GTLROracleDatabase_DatabaseProperties; @class GTLROracleDatabase_DataCollectionOptions; +@class GTLROracleDatabase_DataCollectionOptionsCommon; +@class GTLROracleDatabase_DataCollectionOptionsDbSystem; +@class GTLROracleDatabase_DbBackupConfig; +@class GTLROracleDatabase_DbHome; @class GTLROracleDatabase_DbNode; @class GTLROracleDatabase_DbNodeProperties; @class GTLROracleDatabase_DbServer; @class GTLROracleDatabase_DbServerProperties; +@class GTLROracleDatabase_DbSystem; +@class GTLROracleDatabase_DbSystem_Labels; +@class GTLROracleDatabase_DbSystemInitialStorageSize; +@class GTLROracleDatabase_DbSystemInitialStorageSizeProperties; +@class GTLROracleDatabase_DbSystemOptions; +@class GTLROracleDatabase_DbSystemProperties; @class GTLROracleDatabase_DbSystemShape; +@class GTLROracleDatabase_DbVersion; +@class GTLROracleDatabase_DbVersionProperties; +@class GTLROracleDatabase_DefinedTagValue; +@class GTLROracleDatabase_DefinedTagValue_Tags; +@class GTLROracleDatabase_EncryptionKey; +@class GTLROracleDatabase_EncryptionKeyHistoryEntry; @class GTLROracleDatabase_Entitlement; +@class GTLROracleDatabase_ExadbVmCluster; +@class GTLROracleDatabase_ExadbVmCluster_Labels; +@class GTLROracleDatabase_ExadbVmClusterProperties; +@class GTLROracleDatabase_ExadbVmClusterStorageDetails; +@class GTLROracleDatabase_ExascaleDbStorageDetails; +@class GTLROracleDatabase_ExascaleDbStorageVault; +@class GTLROracleDatabase_ExascaleDbStorageVault_Labels; +@class GTLROracleDatabase_ExascaleDbStorageVaultProperties; @class GTLROracleDatabase_GiVersion; @class GTLROracleDatabase_IdentityConnector; @class GTLROracleDatabase_Location; @class GTLROracleDatabase_Location_Labels; @class GTLROracleDatabase_Location_Metadata; @class GTLROracleDatabase_MaintenanceWindow; +@class GTLROracleDatabase_MinorVersion; @class GTLROracleDatabase_OdbNetwork; @class GTLROracleDatabase_OdbNetwork_Labels; @class GTLROracleDatabase_OdbSubnet; @@ -57,10 +87,18 @@ @class GTLROracleDatabase_Operation; @class GTLROracleDatabase_Operation_Metadata; @class GTLROracleDatabase_Operation_Response; +@class GTLROracleDatabase_PluggableDatabase; +@class GTLROracleDatabase_PluggableDatabaseConnectionStrings; +@class GTLROracleDatabase_PluggableDatabaseConnectionStrings_AllConnectionStrings; +@class GTLROracleDatabase_PluggableDatabaseNodeLevelDetails; +@class GTLROracleDatabase_PluggableDatabaseProperties; +@class GTLROracleDatabase_PluggableDatabaseProperties_DefinedTags; +@class GTLROracleDatabase_PluggableDatabaseProperties_FreeformTags; @class GTLROracleDatabase_ScheduledOperationDetails; @class GTLROracleDatabase_SourceConfig; @class GTLROracleDatabase_Status; @class GTLROracleDatabase_Status_Details_Item; +@class GTLROracleDatabase_StorageSizeDetails; @class GTLROracleDatabase_TimeOfDay; @class GTLROracleDatabase_TimeZone; @@ -865,6 +903,46 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_AutonomousDbVersion_DbWor */ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Oltp; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_BackupDestinationDetails.type + +/** + * Default unspecified value. + * + * Value: "BACKUP_DESTINATION_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_BackupDestinationTypeUnspecified; +/** + * Backup destination type is DBRS. + * + * Value: "DBRS" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_Dbrs; +/** + * Backup destination type is Local. + * + * Value: "LOCAL" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_Local; +/** + * Backup destination type is NFS. + * + * Value: "NFS" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_Nfs; +/** + * Backup destination type is Object Store. + * + * Value: "OBJECT_STORE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_ObjectStore; +/** + * Backup destination type is Recovery Appliance. + * + * Value: "RECOVERY_APPLIANCE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_BackupDestinationDetails_Type_RecoveryAppliance; + // ---------------------------------------------------------------------------- // GTLROracleDatabase_CloudExadataInfrastructureProperties.computeModel @@ -1061,6 +1139,74 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_CloudVmClusterProperties_ */ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_CloudVmClusterProperties_State_Updating; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_Database.opsInsightsStatus + +/** + * Indicates that the operations insights are being disabled. + * + * Value: "DISABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_Disabling; +/** + * Indicates that the operations insights are enabled. + * + * Value: "ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_Enabled; +/** + * Indicates that the operations insights are being enabled. + * + * Value: "ENABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_Enabling; +/** + * Indicates that the operations insights failed to disable. + * + * Value: "FAILED_DISABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_FailedDisabling; +/** + * Indicates that the operations insights failed to enable. + * + * Value: "FAILED_ENABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_FailedEnabling; +/** + * Indicates that the operations insights are not enabled. + * + * Value: "NOT_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_NotEnabled; +/** + * Default unspecified value. + * + * Value: "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Database_OpsInsightsStatus_OperationsInsightsStatusUnspecified; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DatabaseCharacterSet.characterSetType + +/** + * Character set type is not specified. + * + * Value: "CHARACTER_SET_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_CharacterSetTypeUnspecified; +/** + * Character set type is set to database. + * + * Value: "DATABASE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_Database; +/** + * Character set type is set to national. + * + * Value: "NATIONAL" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_National; + // ---------------------------------------------------------------------------- // GTLROracleDatabase_DatabaseConnectionStringProfile.consumerGroup @@ -1218,2794 +1364,5127 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseConnectionStringP FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_TlsAuthenticationUnspecified; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_DbNodeProperties.state +// GTLROracleDatabase_DatabaseManagementConfig.managementState /** - * Indicates that the resource is in available state. - * - * Value: "AVAILABLE" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Available; -/** - * Indicates that the resource is in failed state. + * The Database Management service is disabled. * - * Value: "FAILED" + * Value: "DISABLED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Failed; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Disabled; /** - * Indicates that the resource is in provisioning state. + * The Database Management service is disabling. * - * Value: "PROVISIONING" + * Value: "DISABLING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Provisioning; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Disabling; /** - * Indicates that the resource is in starting state. + * The Database Management service is enabled. * - * Value: "STARTING" + * Value: "ENABLED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Starting; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Enabled; /** - * Default unspecified value. + * The Database Management service is enabling. * - * Value: "STATE_UNSPECIFIED" + * Value: "ENABLING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_StateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Enabling; /** - * Indicates that the resource is in stopped state. + * The Database Management service failed to disable. * - * Value: "STOPPED" + * Value: "FAILED_DISABLING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Stopped; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedDisabling; /** - * Indicates that the resource is in stopping state. + * The Database Management service failed to enable. * - * Value: "STOPPING" + * Value: "FAILED_ENABLING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Stopping; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedEnabling; /** - * Indicates that the resource is in terminated state. + * The Database Management service failed to update. * - * Value: "TERMINATED" + * Value: "FAILED_UPDATING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Terminated; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedUpdating; /** - * Indicates that the resource is in terminating state. + * The status is not specified. * - * Value: "TERMINATING" + * Value: "MANAGEMENT_STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Terminating; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_ManagementStateUnspecified; /** - * Indicates that the resource is in updating state. + * The Database Management service is updating. * * Value: "UPDATING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Updating; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Updating; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_DbServerProperties.state +// GTLROracleDatabase_DatabaseManagementConfig.managementType /** - * Indicates that the resource is in available state. - * - * Value: "AVAILABLE" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Available; -/** - * Indicates that the resource is in creating state. - * - * Value: "CREATING" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Creating; -/** - * Indicates that the resource is in deleted state. - * - * Value: "DELETED" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Deleted; -/** - * Indicates that the resource is in deleting state. + * Advanced Database Management. * - * Value: "DELETING" + * Value: "ADVANCED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Deleting; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_Advanced; /** - * Default unspecified value. + * Basic Database Management. * - * Value: "STATE_UNSPECIFIED" + * Value: "BASIC" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_StateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_Basic; /** - * Indicates that the resource is in unavailable state. + * The type is not specified. * - * Value: "UNAVAILABLE" + * Value: "MANAGEMENT_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Unavailable; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_ManagementTypeUnspecified; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_Entitlement.state +// GTLROracleDatabase_DatabaseProperties.state /** - * Account is linked but not active. - * - * Value: "ACCOUNT_NOT_ACTIVE" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_AccountNotActive; -/** - * Account not linked. - * - * Value: "ACCOUNT_NOT_LINKED" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_AccountNotLinked; -/** - * Account is suspended. + * Indicates that the resource is in available state. * - * Value: "ACCOUNT_SUSPENDED" + * Value: "AVAILABLE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_AccountSuspended; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Available; /** - * Entitlement and Account are active. + * Indicates that the resource is in backup in progress state. * - * Value: "ACTIVE" + * Value: "BACKUP_IN_PROGRESS" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_Active; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_BackupInProgress; /** - * Entitlement is not approved in private marketplace. + * Indicates that the resource is in converting state. * - * Value: "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" + * Value: "CONVERTING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_NotApprovedInPrivateMarketplace; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Converting; /** * Default unspecified value. * - * Value: "STATE_UNSPECIFIED" - */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_StateUnspecified; - -// ---------------------------------------------------------------------------- -// GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest.type - -/** - * Used to generate wallet for all databases in the region. - * - * Value: "ALL" + * Value: "DATABASE_LIFECYCLE_STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_All; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_DatabaseLifecycleStateUnspecified; /** - * Default unspecified value. + * Indicates that the resource is in failed state. * - * Value: "GENERATE_TYPE_UNSPECIFIED" + * Value: "FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_GenerateTypeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Failed; /** - * Used to generate wallet for a single database. + * Indicates that the resource is in provisioning state. * - * Value: "SINGLE" + * Value: "PROVISIONING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_Single; - -// ---------------------------------------------------------------------------- -// GTLROracleDatabase_IdentityConnector.connectionState - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Provisioning; /** - * The identity pool connection is connected. + * Indicates that the resource is in restore failed state. * - * Value: "CONNECTED" + * Value: "RESTORE_FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_Connected; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_RestoreFailed; /** - * Default unspecified value. + * Indicates that the resource is in terminated state. * - * Value: "CONNECTION_STATE_UNSPECIFIED" + * Value: "TERMINATED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_ConnectionStateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Terminated; /** - * The identity pool connection is disconnected. + * Indicates that the resource is in terminating state. * - * Value: "DISCONNECTED" + * Value: "TERMINATING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_Disconnected; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Terminating; /** - * The identity pool connection is partially connected. + * Indicates that the resource is in updating state. * - * Value: "PARTIALLY_CONNECTED" + * Value: "UPDATING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_PartiallyConnected; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Updating; /** - * The identity pool connection is in an unknown state. + * Indicates that the resource is in upgrading state. * - * Value: "UNKNOWN" + * Value: "UPGRADING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_Unknown; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DatabaseProperties_State_Upgrading; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_MaintenanceWindow.daysOfWeek +// GTLROracleDatabase_DbBackupConfig.autoFullBackupDay /** * The day of the week is unspecified. * * Value: "DAY_OF_WEEK_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_DayOfWeekUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_DayOfWeekUnspecified; /** * Friday * * Value: "FRIDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Friday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Friday; /** * Monday * * Value: "MONDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Monday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Monday; /** * Saturday * * Value: "SATURDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Saturday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Saturday; /** * Sunday * * Value: "SUNDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Sunday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Sunday; /** * Thursday * * Value: "THURSDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Thursday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Thursday; /** * Tuesday * * Value: "TUESDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Tuesday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Tuesday; /** * Wednesday * * Value: "WEDNESDAY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Wednesday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Wednesday; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_MaintenanceWindow.months +// GTLROracleDatabase_DbBackupConfig.autoFullBackupWindow /** - * The month of April. + * Default unspecified value. * - * Value: "APRIL" + * Value: "BACKUP_WINDOW_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_April; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_BackupWindowUnspecified; /** - * The month of August. + * 2:00 PM - 4:00 PM * - * Value: "AUGUST" + * Value: "SLOT_EIGHT" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_August; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotEight; /** - * The month of December. + * 8:00 PM - 10:00 PM * - * Value: "DECEMBER" + * Value: "SLOT_ELEVEN" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_December; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotEleven; /** - * The month of February. + * 8:00 AM - 10:00 AM * - * Value: "FEBRUARY" + * Value: "SLOT_FIVE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_February; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotFive; /** - * The month of January. + * 6:00 AM - 8:00 AM * - * Value: "JANUARY" + * Value: "SLOT_FOUR" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_January; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotFour; /** - * The month of July. + * 4:00 PM - 6:00 PM * - * Value: "JULY" + * Value: "SLOT_NINE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_July; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotNine; /** - * The month of June. + * 12:00 AM - 2:00 AM * - * Value: "JUNE" + * Value: "SLOT_ONE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_June; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotOne; /** - * The month of March. + * 12:00 PM - 2:00 PM * - * Value: "MARCH" + * Value: "SLOT_SEVEN" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_March; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotSeven; /** - * The month of May. + * 10:00 AM - 12:00 PM * - * Value: "MAY" + * Value: "SLOT_SIX" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_May; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotSix; /** - * The unspecified month. + * 6:00 PM - 8:00 PM * - * Value: "MONTH_UNSPECIFIED" + * Value: "SLOT_TEN" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_MonthUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTen; /** - * The month of November. + * 4:00 AM - 6:00 AM * - * Value: "NOVEMBER" + * Value: "SLOT_THREE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_November; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotThree; /** - * The month of October. + * 10:00 PM - 12:00 AM * - * Value: "OCTOBER" + * Value: "SLOT_TWELVE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_October; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTwelve; /** - * The month of September. + * 2:00 AM - 4:00 AM * - * Value: "SEPTEMBER" + * Value: "SLOT_TWO" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_September; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTwo; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_MaintenanceWindow.patchingMode +// GTLROracleDatabase_DbBackupConfig.autoIncrementalBackupWindow /** - * The non-rolling maintenance method first updates your storage servers at the - * same time, then your database servers at the same time. + * Default unspecified value. * - * Value: "NON_ROLLING" + * Value: "BACKUP_WINDOW_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_PatchingMode_NonRolling; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_BackupWindowUnspecified; /** - * Default unspecified value. + * 2:00 PM - 4:00 PM * - * Value: "PATCHING_MODE_UNSPECIFIED" + * Value: "SLOT_EIGHT" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_PatchingMode_PatchingModeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotEight; /** - * Updates the Cloud Exadata database server hosts in a rolling fashion. + * 8:00 PM - 10:00 PM * - * Value: "ROLLING" + * Value: "SLOT_ELEVEN" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_PatchingMode_Rolling; - -// ---------------------------------------------------------------------------- -// GTLROracleDatabase_MaintenanceWindow.preference - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotEleven; /** - * Custom preference. + * 8:00 AM - 10:00 AM * - * Value: "CUSTOM_PREFERENCE" + * Value: "SLOT_FIVE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Preference_CustomPreference; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotFive; /** - * Default unspecified value. + * 6:00 AM - 8:00 AM * - * Value: "MAINTENANCE_WINDOW_PREFERENCE_UNSPECIFIED" + * Value: "SLOT_FOUR" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Preference_MaintenanceWindowPreferenceUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotFour; /** - * No preference. + * 4:00 PM - 6:00 PM * - * Value: "NO_PREFERENCE" + * Value: "SLOT_NINE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Preference_NoPreference; - -// ---------------------------------------------------------------------------- -// GTLROracleDatabase_OdbNetwork.state - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotNine; /** - * Indicates that the resource is in available state. + * 12:00 AM - 2:00 AM * - * Value: "AVAILABLE" + * Value: "SLOT_ONE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Available; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotOne; /** - * Indicates that the resource is in failed state. + * 12:00 PM - 2:00 PM * - * Value: "FAILED" + * Value: "SLOT_SEVEN" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Failed; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotSeven; /** - * Indicates that the resource is in provisioning state. + * 10:00 AM - 12:00 PM * - * Value: "PROVISIONING" + * Value: "SLOT_SIX" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Provisioning; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotSix; /** - * Default unspecified value. + * 6:00 PM - 8:00 PM * - * Value: "STATE_UNSPECIFIED" + * Value: "SLOT_TEN" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_StateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTen; /** - * Indicates that the resource is in terminating state. + * 4:00 AM - 6:00 AM * - * Value: "TERMINATING" + * Value: "SLOT_THREE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Terminating; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotThree; +/** + * 10:00 PM - 12:00 AM + * + * Value: "SLOT_TWELVE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTwelve; +/** + * 2:00 AM - 4:00 AM + * + * Value: "SLOT_TWO" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTwo; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_OdbSubnet.purpose +// GTLROracleDatabase_DbBackupConfig.backupDeletionPolicy /** - * Subnet to be used for backup. + * Default unspecified value. * - * Value: "BACKUP_SUBNET" + * Value: "BACKUP_DELETION_POLICY_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_Purpose_BackupSubnet; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_BackupDeletionPolicyUnspecified; /** - * Subnet to be used for client connections. + * Keeps the backups as per the policy defined for database backups. * - * Value: "CLIENT_SUBNET" + * Value: "DELETE_AFTER_RETENTION_PERIOD" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_Purpose_ClientSubnet; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_DeleteAfterRetentionPeriod; /** - * Default unspecified value. + * Keeps the backup for predefined time i.e. 72 hours and then delete + * permanently. * - * Value: "PURPOSE_UNSPECIFIED" + * Value: "DELETE_IMMEDIATELY" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_Purpose_PurposeUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_DeleteImmediately; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_OdbSubnet.state +// GTLROracleDatabase_DbNodeProperties.state /** * Indicates that the resource is in available state. * * Value: "AVAILABLE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Available; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Available; /** * Indicates that the resource is in failed state. * * Value: "FAILED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Failed; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Failed; /** * Indicates that the resource is in provisioning state. * * Value: "PROVISIONING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Provisioning; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Provisioning; +/** + * Indicates that the resource is in starting state. + * + * Value: "STARTING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Starting; /** * Default unspecified value. * * Value: "STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_StateUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_StateUnspecified; +/** + * Indicates that the resource is in stopped state. + * + * Value: "STOPPED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Stopped; +/** + * Indicates that the resource is in stopping state. + * + * Value: "STOPPING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Stopping; +/** + * Indicates that the resource is in terminated state. + * + * Value: "TERMINATED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Terminated; /** * Indicates that the resource is in terminating state. * * Value: "TERMINATING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Terminating; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Terminating; +/** + * Indicates that the resource is in updating state. + * + * Value: "UPDATING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbNodeProperties_State_Updating; // ---------------------------------------------------------------------------- -// GTLROracleDatabase_ScheduledOperationDetails.dayOfWeek +// GTLROracleDatabase_DbServerProperties.state /** - * The day of the week is unspecified. + * Indicates that the resource is in available state. * - * Value: "DAY_OF_WEEK_UNSPECIFIED" + * Value: "AVAILABLE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_DayOfWeekUnspecified; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Available; /** - * Friday + * Indicates that the resource is in creating state. * - * Value: "FRIDAY" + * Value: "CREATING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Friday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Creating; /** - * Monday + * Indicates that the resource is in deleted state. * - * Value: "MONDAY" + * Value: "DELETED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Monday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Deleted; /** - * Saturday + * Indicates that the resource is in deleting state. * - * Value: "SATURDAY" + * Value: "DELETING" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Saturday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Deleting; /** - * Sunday + * Default unspecified value. * - * Value: "SUNDAY" + * Value: "STATE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Sunday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_StateUnspecified; /** - * Thursday + * Indicates that the resource is in unavailable state. * - * Value: "THURSDAY" + * Value: "UNAVAILABLE" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Thursday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbServerProperties_State_Unavailable; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemInitialStorageSizeProperties.shapeType + /** - * Tuesday + * Unspecified shape type. * - * Value: "TUESDAY" + * Value: "SHAPE_TYPE_UNSPECIFIED" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Tuesday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_ShapeType_ShapeTypeUnspecified; /** - * Wednesday + * Standard X86. * - * Value: "WEDNESDAY" + * Value: "STANDARD_X86" */ -FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Wednesday; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_ShapeType_StandardX86; -/** - * A list of all connection strings that can be used to connect to the - * Autonomous Database. - */ -@interface GTLROracleDatabase_AllConnectionStrings : GTLRObject +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemInitialStorageSizeProperties.storageManagement /** - * Output only. The database service provides the highest level of resources to - * each SQL statement. + * Automatic Storage Management. + * + * Value: "ASM" */ -@property(nonatomic, copy, nullable) NSString *high; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_Asm; /** - * Output only. The database service provides the least level of resources to - * each SQL statement. + * Logical Volume Management. + * + * Value: "LVM" */ -@property(nonatomic, copy, nullable) NSString *low; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_Lvm; /** - * Output only. The database service provides a lower level of resources to - * each SQL statement. + * Unspecified storage management. + * + * Value: "STORAGE_MANAGEMENT_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *medium; - -@end +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_StorageManagementUnspecified; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemOptions.storageManagement /** - * Details of the Autonomous Database resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ + * Automatic storage management. + * + * Value: "ASM" */ -@interface GTLROracleDatabase_AutonomousDatabase : GTLRObject - -/** Optional. The password for the default ADMIN user. */ -@property(nonatomic, copy, nullable) NSString *adminPassword; - -/** Optional. The subnet CIDR range for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *cidr; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemOptions_StorageManagement_Asm; /** - * Output only. The date and time that the Autonomous Database was created. + * Logical Volume management. + * + * Value: "LVM" */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemOptions_StorageManagement_Lvm; /** - * Optional. The name of the Autonomous Database. The database name must be - * unique in the project. The name must begin with a letter and can contain a - * maximum of 30 alphanumeric characters. + * The storage management is unspecified. + * + * Value: "STORAGE_MANAGEMENT_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *database; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemOptions_StorageManagement_StorageManagementUnspecified; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemProperties.computeModel /** - * Output only. List of supported GCP region to clone the Autonomous Database - * for disaster recovery. Format: `project/{project}/locations/{location}`. + * The compute model is unspecified. + * + * Value: "COMPUTE_MODEL_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSArray *disasterRecoverySupportedLocations; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_ComputeModel_ComputeModelUnspecified; /** - * Optional. The display name for the Autonomous Database. The name does not - * have to be unique within your project. + * The compute model is virtual. + * + * Value: "ECPU" */ -@property(nonatomic, copy, nullable) NSString *displayName; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_ComputeModel_Ecpu; /** - * Output only. The ID of the subscription entitlement associated with the - * Autonomous Database. + * The compute model is physical. + * + * Value: "OCPU" */ -@property(nonatomic, copy, nullable) NSString *entitlementId; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_ComputeModel_Ocpu; -/** Optional. The labels or tags associated with the Autonomous Database. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabase_Labels *labels; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemProperties.databaseEdition /** - * Identifier. The name of the Autonomous Database resource in the following - * format: - * projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + * The database edition is unspecified. + * + * Value: "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *name; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_DbSystemDatabaseEditionUnspecified; /** - * Optional. The name of the VPC network used by the Autonomous Database in the - * following format: projects/{project}/global/networks/{network} + * The database edition is Enterprise. + * + * Value: "ENTERPRISE_EDITION" */ -@property(nonatomic, copy, nullable) NSString *network; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_EnterpriseEdition; /** - * Optional. The name of the OdbNetwork associated with the Autonomous - * Database. Format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network} It is - * optional but if specified, this should match the parent ODBNetwork of the - * OdbSubnet. + * The database edition is Enterprise Edition. + * + * Value: "ENTERPRISE_EDITION_HIGH_PERFORMANCE" */ -@property(nonatomic, copy, nullable) NSString *odbNetwork; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_EnterpriseEditionHighPerformance; /** - * Optional. The name of the OdbSubnet associated with the Autonomous Database. - * Format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + * The database edition is Standard. + * + * Value: "STANDARD_EDITION" */ -@property(nonatomic, copy, nullable) NSString *odbSubnet; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_StandardEdition; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemProperties.licenseModel /** - * Output only. The peer Autonomous Database names of the given Autonomous - * Database. + * The license model is bring your own license. + * + * Value: "BRING_YOUR_OWN_LICENSE" */ -@property(nonatomic, strong, nullable) NSArray *peerAutonomousDatabases; - -/** Optional. The properties of the Autonomous Database. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseProperties *properties; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LicenseModel_BringYourOwnLicense; /** - * Optional. The source Autonomous Database configuration for the standby - * Autonomous Database. The source Autonomous Database is configured while - * creating the Peer Autonomous Database and can't be updated after creation. + * The license model is included. + * + * Value: "LICENSE_INCLUDED" */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_SourceConfig *sourceConfig; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LicenseModel_LicenseIncluded; /** - * Optional. The labels or tags associated with the Autonomous Database. + * The license model is unspecified. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Value: "LICENSE_MODEL_UNSPECIFIED" */ -@interface GTLROracleDatabase_AutonomousDatabase_Labels : GTLRObject -@end +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LicenseModel_LicenseModelUnspecified; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_DbSystemProperties.lifecycleState /** - * Oracle APEX Application Development. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex + * Indicates that the resource is in available state. + * + * Value: "AVAILABLE" */ -@interface GTLROracleDatabase_AutonomousDatabaseApex : GTLRObject - -/** Output only. The Oracle APEX Application Development version. */ -@property(nonatomic, copy, nullable) NSString *apexVersion; - -/** Output only. The Oracle REST Data Services (ORDS) version. */ -@property(nonatomic, copy, nullable) NSString *ordsVersion; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Available; /** - * Details of the Autonomous Database Backup resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/ + * Default unspecified value. + * + * Value: "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED" */ -@interface GTLROracleDatabase_AutonomousDatabaseBackup : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_DbSystemLifecycleStateUnspecified; /** - * Required. The name of the Autonomous Database resource for which the backup - * is being created. Format: - * projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + * Indicates that the resource is in failed state. + * + * Value: "FAILED" */ -@property(nonatomic, copy, nullable) NSString *autonomousDatabase; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Failed; /** - * Optional. User friendly name for the Backup. The name does not have to be - * unique. + * Indicates that the resource is in maintenance in progress state. + * + * Value: "MAINTENANCE_IN_PROGRESS" */ -@property(nonatomic, copy, nullable) NSString *displayName; - -/** Optional. labels or tags associated with the resource. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseBackup_Labels *labels; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_MaintenanceInProgress; /** - * Identifier. The name of the Autonomous Database Backup resource with the - * format: - * projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup} + * Indicates that the resource has been migrated. + * + * Value: "MIGRATED" */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Optional. Various properties of the backup. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseBackupProperties *properties; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Migrated; /** - * Optional. labels or tags associated with the resource. + * Indicates that the resource needs attention. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Value: "NEEDS_ATTENTION" */ -@interface GTLROracleDatabase_AutonomousDatabaseBackup_Labels : GTLRObject -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_NeedsAttention; /** - * Properties of the Autonomous Database Backup resource. + * Indicates that the resource is in provisioning state. + * + * Value: "PROVISIONING" */ -@interface GTLROracleDatabase_AutonomousDatabaseBackupProperties : GTLRObject - -/** Output only. Timestamp until when the backup will be available. */ -@property(nonatomic, strong, nullable) GTLRDateTime *availableTillTime; - -/** Output only. The OCID of the compartment. */ -@property(nonatomic, copy, nullable) NSString *compartmentId; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Provisioning; /** - * Output only. The quantity of data in the database, in terabytes. + * Indicates that the resource is in terminated state. * - * Uses NSNumber of floatValue. + * Value: "TERMINATED" */ -@property(nonatomic, strong, nullable) NSNumber *databaseSizeTb; - -/** Output only. A valid Oracle Database version for Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *dbVersion; - -/** Output only. The date and time the backup completed. */ -@property(nonatomic, strong, nullable) GTLRDateTime *endTime; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Terminated; /** - * Output only. Indicates if the backup is automatic or user initiated. + * Indicates that the resource is in terminating state. * - * Uses NSNumber of boolValue. + * Value: "TERMINATING" */ -@property(nonatomic, strong, nullable) NSNumber *isAutomaticBackup; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Terminating; /** - * Output only. Indicates if the backup is long term backup. + * Indicates that the resource is in updating state. * - * Uses NSNumber of boolValue. + * Value: "UPDATING" */ -@property(nonatomic, strong, nullable) NSNumber *isLongTermBackup; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Updating; /** - * Output only. Indicates if the backup can be used to restore the Autonomous - * Database. + * Indicates that the resource is upgrading. * - * Uses NSNumber of boolValue. + * Value: "UPGRADING" */ -@property(nonatomic, strong, nullable) NSNumber *isRestorable; - -/** Optional. The OCID of the key store of Oracle Vault. */ -@property(nonatomic, copy, nullable) NSString *keyStoreId; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_DbSystemProperties_LifecycleState_Upgrading; -/** Optional. The wallet name for Oracle Key Vault. */ -@property(nonatomic, copy, nullable) NSString *keyStoreWallet; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_EncryptionKey.provider /** - * Optional. The OCID of the key container that is used as the master - * encryption key in database transparent data encryption (TDE) operations. + * Google Managed KMS key, if selected, please provide the KMS key name. + * + * Value: "GOOGLE_MANAGED" */ -@property(nonatomic, copy, nullable) NSString *kmsKeyId; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_EncryptionKey_Provider_GoogleManaged; /** - * Optional. The OCID of the key container version that is used in database - * transparent data encryption (TDE) operations KMS Key can have multiple key - * versions. If none is specified, the current key version (latest) of the Key - * Id is used for the operation. Autonomous Database Serverless does not use - * key versions, hence is not applicable for Autonomous Database Serverless - * instances. + * Oracle Managed. + * + * Value: "ORACLE_MANAGED" */ -@property(nonatomic, copy, nullable) NSString *kmsKeyVersionId; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_EncryptionKey_Provider_OracleManaged; +/** + * Default unspecified value. + * + * Value: "PROVIDER_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_EncryptionKey_Provider_ProviderUnspecified; -/** Output only. Additional information about the current lifecycle state. */ -@property(nonatomic, copy, nullable) NSString *lifecycleDetails; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_Entitlement.state /** - * Output only. The lifecycle state of the backup. + * Account is linked but not active. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Active - * Indicates that the resource is in active state. (Value: "ACTIVE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Creating - * Indicates that the resource is in creating state. (Value: "CREATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Deleted - * Indicates that the resource is in deleted state. (Value: "DELETED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Deleting - * Indicates that the resource is in deleting state. (Value: "DELETING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Failed - * Indicates that the resource is in failed state. (Value: "FAILED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_StateUnspecified - * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Updating - * Indicates that the resource is in updating state. (Value: "UPDATING") + * Value: "ACCOUNT_NOT_ACTIVE" */ -@property(nonatomic, copy, nullable) NSString *lifecycleState; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_AccountNotActive; /** - * Output only. OCID of the Autonomous Database backup. - * https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + * Account not linked. + * + * Value: "ACCOUNT_NOT_LINKED" */ -@property(nonatomic, copy, nullable) NSString *ocid; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_AccountNotLinked; /** - * Optional. Retention period in days for the backup. + * Account is suspended. * - * Uses NSNumber of intValue. + * Value: "ACCOUNT_SUSPENDED" */ -@property(nonatomic, strong, nullable) NSNumber *retentionPeriodDays; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_AccountSuspended; /** - * Output only. The backup size in terabytes. + * Entitlement and Account are active. * - * Uses NSNumber of floatValue. + * Value: "ACTIVE" */ -@property(nonatomic, strong, nullable) NSNumber *sizeTb; - -/** Output only. The date and time the backup started. */ -@property(nonatomic, strong, nullable) GTLRDateTime *startTime; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_Active; /** - * Output only. The type of the backup. + * Entitlement is not approved in private marketplace. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_Full - * Full backups. (Value: "FULL") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_Incremental - * Incremental backups. (Value: "INCREMENTAL") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_LongTerm - * Long term backups. (Value: "LONG_TERM") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_TypeUnspecified - * Default unspecified value. (Value: "TYPE_UNSPECIFIED") + * Value: "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" */ -@property(nonatomic, copy, nullable) NSString *type; - -/** Optional. The OCID of the vault. */ -@property(nonatomic, copy, nullable) NSString *vaultId; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_NotApprovedInPrivateMarketplace; /** - * Details of the Autonomous Database character set resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ + * Default unspecified value. + * + * Value: "STATE_UNSPECIFIED" */ -@interface GTLROracleDatabase_AutonomousDatabaseCharacterSet : GTLRObject +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_Entitlement_State_StateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ExadbVmClusterProperties.licenseModel /** - * Output only. The character set name for the Autonomous Database which is the - * ID in the resource name. + * Bring your own license. + * + * Value: "BRING_YOUR_OWN_LICENSE" */ -@property(nonatomic, copy, nullable) NSString *characterSet; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_BringYourOwnLicense; /** - * Output only. The character set type for the Autonomous Database. + * Default is license included. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseCharacterSet_CharacterSetType_CharacterSetTypeUnspecified - * Character set type is not specified. (Value: - * "CHARACTER_SET_TYPE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseCharacterSet_CharacterSetType_Database - * Character set type is set to database. (Value: "DATABASE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseCharacterSet_CharacterSetType_National - * Character set type is set to national. (Value: "NATIONAL") + * Value: "LICENSE_INCLUDED" */ -@property(nonatomic, copy, nullable) NSString *characterSetType; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_LicenseIncluded; /** - * Identifier. The name of the Autonomous Database Character Set resource in - * the following format: - * projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set} + * Unspecified. + * + * Value: "LICENSE_MODEL_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *name; - -@end +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_LicenseModelUnspecified; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ExadbVmClusterProperties.lifecycleState /** - * The connection string used to connect to the Autonomous Database. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings + * Indicates that the resource is in available state. + * + * Value: "AVAILABLE" */ -@interface GTLROracleDatabase_AutonomousDatabaseConnectionStrings : GTLRObject - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Available; /** - * Output only. Returns all connection strings that can be used to connect to - * the Autonomous Database. + * Default unspecified value. + * + * Value: "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AllConnectionStrings *allConnectionStrings; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_ExadbVmClusterLifecycleStateUnspecified; /** - * Output only. The database service provides the least level of resources to - * each SQL statement, but supports the most number of concurrent SQL - * statements. + * Indicates that the resource is in failed state. + * + * Value: "FAILED" */ -@property(nonatomic, copy, nullable) NSString *dedicated; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Failed; /** - * Output only. The database service provides the highest level of resources to - * each SQL statement. + * Indicates that the resource is in maintenance in progress state. + * + * Value: "MAINTENANCE_IN_PROGRESS" */ -@property(nonatomic, copy, nullable) NSString *high; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_MaintenanceInProgress; /** - * Output only. The database service provides the least level of resources to - * each SQL statement. + * Indicates that the resource is in provisioning state. + * + * Value: "PROVISIONING" */ -@property(nonatomic, copy, nullable) NSString *low; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Provisioning; /** - * Output only. The database service provides a lower level of resources to - * each SQL statement. + * Indicates that the resource is in terminated state. + * + * Value: "TERMINATED" */ -@property(nonatomic, copy, nullable) NSString *medium; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Terminated; /** - * Output only. A list of connection string profiles to allow clients to group, - * filter, and select values based on the structured metadata. + * Indicates that the resource is in terminating state. + * + * Value: "TERMINATING" */ -@property(nonatomic, strong, nullable) NSArray *profiles; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Terminating; /** - * The URLs for accessing Oracle Application Express (APEX) and SQL Developer - * Web with a browser from a Compute instance. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls + * Indicates that the resource is in updating state. + * + * Value: "UPDATING" */ -@interface GTLROracleDatabase_AutonomousDatabaseConnectionUrls : GTLRObject +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Updating; -/** Output only. Oracle Application Express (APEX) URL. */ -@property(nonatomic, copy, nullable) NSString *apexUri; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ExadbVmClusterProperties.shapeAttribute /** - * Output only. The URL of the Database Transforms for the Autonomous Database. + * Indicates that the resource is in block storage. + * + * Value: "BLOCK_STORAGE" */ -@property(nonatomic, copy, nullable) NSString *databaseTransformsUri; - -/** Output only. The URL of the Graph Studio for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *graphStudioUri; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_BlockStorage; /** - * Output only. The URL of the Oracle Machine Learning (OML) Notebook for the - * Autonomous Database. + * Default unspecified value. + * + * Value: "SHAPE_ATTRIBUTE_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *machineLearningNotebookUri; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_ShapeAttributeUnspecified; /** - * Output only. The URL of Machine Learning user management the Autonomous - * Database. + * Indicates that the resource is in smart storage. + * + * Value: "SMART_STORAGE" */ -@property(nonatomic, copy, nullable) NSString *machineLearningUserManagementUri; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_SmartStorage; -/** Output only. The URL of the MongoDB API for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *mongoDbUri; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ExascaleDbStorageVaultProperties.attachedShapeAttributes /** - * Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for - * the Autonomous Database. + * Indicates that the resource is in block storage. + * + * Value: "BLOCK_STORAGE" */ -@property(nonatomic, copy, nullable) NSString *ordsUri; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AttachedShapeAttributes_BlockStorage; /** - * Output only. The URL of the Oracle SQL Developer Web for the Autonomous - * Database. + * Default unspecified value. + * + * Value: "SHAPE_ATTRIBUTE_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *sqlDevWebUri; - -@end - - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AttachedShapeAttributes_ShapeAttributeUnspecified; /** - * The properties of an Autonomous Database. + * Indicates that the resource is in smart storage. + * + * Value: "SMART_STORAGE" */ -@interface GTLROracleDatabase_AutonomousDatabaseProperties : GTLRObject +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AttachedShapeAttributes_SmartStorage; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ExascaleDbStorageVaultProperties.availableShapeAttributes /** - * Output only. The amount of storage currently being used for user and system - * data, in terabytes. + * Indicates that the resource is in block storage. * - * Uses NSNumber of doubleValue. + * Value: "BLOCK_STORAGE" */ -@property(nonatomic, strong, nullable) NSNumber *actualUsedDataStorageSizeTb; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AvailableShapeAttributes_BlockStorage; /** - * Output only. The amount of storage currently allocated for the database - * tables and billed for, rounded up in terabytes. + * Default unspecified value. * - * Uses NSNumber of doubleValue. + * Value: "SHAPE_ATTRIBUTE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *allocatedStorageSizeTb; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AvailableShapeAttributes_ShapeAttributeUnspecified; /** - * Optional. The list of allowlisted IP addresses for the Autonomous Database. + * Indicates that the resource is in smart storage. + * + * Value: "SMART_STORAGE" */ -@property(nonatomic, strong, nullable) NSArray *allowlistedIps; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_AvailableShapeAttributes_SmartStorage; -/** Output only. The details for the Oracle APEX Application Development. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseApex *apexDetails; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ExascaleDbStorageVaultProperties.state /** - * Output only. This field indicates the status of Data Guard and Access - * control for the Autonomous Database. The field's value is null if Data Guard - * is disabled or Access Control is disabled. The field's value is TRUE if both - * Data Guard and Access Control are enabled, and the Autonomous Database is - * using primary IP access control list (ACL) for standby. The field's value is - * FALSE if both Data Guard and Access Control are enabled, and the Autonomous - * Database is using a different IP access control list (ACL) for standby - * compared to primary. + * The ExascaleDbStorageVault is available. * - * Uses NSNumber of boolValue. + * Value: "AVAILABLE" */ -@property(nonatomic, strong, nullable) NSNumber *arePrimaryAllowlistedIpsUsed; - -/** Output only. The Autonomous Container Database OCID. */ -@property(nonatomic, copy, nullable) NSString *autonomousContainerDatabaseId; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Available; /** - * Output only. The list of available Oracle Database upgrade versions for an - * Autonomous Database. + * The ExascaleDbStorageVault has failed. + * + * Value: "FAILED" */ -@property(nonatomic, strong, nullable) NSArray *availableUpgradeVersions; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Failed; /** - * Optional. The retention period for the Autonomous Database. This field is - * specified in days, can range from 1 day to 60 days, and has a default value - * of 60 days. + * The ExascaleDbStorageVault is being provisioned. * - * Uses NSNumber of intValue. + * Value: "PROVISIONING" */ -@property(nonatomic, strong, nullable) NSNumber *backupRetentionPeriodDays; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Provisioning; /** - * Optional. The character set for the Autonomous Database. The default is - * AL32UTF8. + * The state of the ExascaleDbStorageVault is unspecified. + * + * Value: "STATE_UNSPECIFIED" */ -@property(nonatomic, copy, nullable) NSString *characterSet; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_StateUnspecified; /** - * Optional. The number of compute servers for the Autonomous Database. + * The ExascaleDbStorageVault has been deleted. * - * Uses NSNumber of floatValue. + * Value: "TERMINATED" */ -@property(nonatomic, strong, nullable) NSNumber *computeCount; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Terminated; /** - * Output only. The connection strings used to connect to an Autonomous - * Database. + * The ExascaleDbStorageVault is being deleted. + * + * Value: "TERMINATING" */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseConnectionStrings *connectionStrings; - -/** Output only. The Oracle Connection URLs for an Autonomous Database. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseConnectionUrls *connectionUrls; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Terminating; /** - * Optional. The number of CPU cores to be made available to the database. + * The ExascaleDbStorageVault is being updated. * - * Uses NSNumber of intValue. + * Value: "UPDATING" */ -@property(nonatomic, strong, nullable) NSNumber *cpuCoreCount; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Updating; -/** Optional. The list of customer contacts. */ -@property(nonatomic, strong, nullable) NSArray *customerContacts; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest.type /** - * Output only. The current state of database management for the Autonomous - * Database. + * Used to generate wallet for all databases in the region. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_DatabaseManagementStateUnspecified - * Default unspecified value. (Value: - * "DATABASE_MANAGEMENT_STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_Disabling - * Disabling Database Management state (Value: "DISABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_Enabled - * Enabled Database Management state (Value: "ENABLED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_Enabling - * Enabling Database Management state (Value: "ENABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_FailedDisabling - * Failed disabling Database Management state (Value: "FAILED_DISABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_FailedEnabling - * Failed enabling Database Management state (Value: "FAILED_ENABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_NotEnabled - * Not Enabled Database Management state (Value: "NOT_ENABLED") + * Value: "ALL" */ -@property(nonatomic, copy, nullable) NSString *databaseManagementState; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_All; /** - * Output only. The date and time the Autonomous Data Guard role was changed - * for the standby Autonomous Database. + * Default unspecified value. + * + * Value: "GENERATE_TYPE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) GTLRDateTime *dataGuardRoleChangedTime; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_GenerateTypeUnspecified; /** - * Output only. The current state of the Data Safe registration for the - * Autonomous Database. + * Used to generate wallet for a single database. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_DataSafeStateUnspecified - * Default unspecified value. (Value: "DATA_SAFE_STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Deregistering - * Deregistering data safe state. (Value: "DEREGISTERING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Failed - * Failed data safe state. (Value: "FAILED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_NotRegistered - * Not registered data safe state. (Value: "NOT_REGISTERED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Registered - * Registered data safe state. (Value: "REGISTERED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Registering - * Registering data safe state. (Value: "REGISTERING") + * Value: "SINGLE" */ -@property(nonatomic, copy, nullable) NSString *dataSafeState; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_GenerateAutonomousDatabaseWalletRequest_Type_Single; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_IdentityConnector.connectionState /** - * Optional. The size of the data stored in the database, in gigabytes. + * The identity pool connection is connected. * - * Uses NSNumber of intValue. + * Value: "CONNECTED" */ -@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeGb; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_Connected; /** - * Optional. The size of the data stored in the database, in terabytes. + * Default unspecified value. * - * Uses NSNumber of intValue. + * Value: "CONNECTION_STATE_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeTb; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_ConnectionStateUnspecified; /** - * Optional. The edition of the Autonomous Databases. + * The identity pool connection is disconnected. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbEdition_DatabaseEditionUnspecified - * Default unspecified value. (Value: "DATABASE_EDITION_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbEdition_EnterpriseEdition - * Enterprise Database Edition (Value: "ENTERPRISE_EDITION") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbEdition_StandardEdition - * Standard Database Edition (Value: "STANDARD_EDITION") + * Value: "DISCONNECTED" */ -@property(nonatomic, copy, nullable) NSString *dbEdition; - -/** Optional. The Oracle Database version for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *dbVersion; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_Disconnected; /** - * Required. The workload type of the Autonomous Database. + * The identity pool connection is partially connected. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Ajd - * Autonomous JSON Database. (Value: "AJD") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Apex - * Autonomous Database with the Oracle APEX Application Development - * workload type. (Value: "APEX") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_DbWorkloadUnspecified - * Default unspecified value. (Value: "DB_WORKLOAD_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Dw - * Autonomous Data Warehouse database. (Value: "DW") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Oltp - * Autonomous Transaction Processing database. (Value: "OLTP") + * Value: "PARTIALLY_CONNECTED" */ -@property(nonatomic, copy, nullable) NSString *dbWorkload; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_PartiallyConnected; /** - * Output only. The date and time the Disaster Recovery role was changed for - * the standby Autonomous Database. + * The identity pool connection is in an unknown state. + * + * Value: "UNKNOWN" */ -@property(nonatomic, strong, nullable) GTLRDateTime *disasterRecoveryRoleChangedTime; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_IdentityConnector_ConnectionState_Unknown; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_MaintenanceWindow.daysOfWeek /** - * Output only. This field indicates the number of seconds of data loss during - * a Data Guard failover. + * The day of the week is unspecified. + * + * Value: "DAY_OF_WEEK_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) GTLRDuration *failedDataRecoveryDuration; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_DayOfWeekUnspecified; /** - * Optional. This field indicates if auto scaling is enabled for the Autonomous - * Database CPU core count. + * Friday * - * Uses NSNumber of boolValue. + * Value: "FRIDAY" */ -@property(nonatomic, strong, nullable) NSNumber *isAutoScalingEnabled; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Friday; /** - * Output only. This field indicates whether the Autonomous Database has local - * (in-region) Data Guard enabled. + * Monday * - * Uses NSNumber of boolValue. + * Value: "MONDAY" */ -@property(nonatomic, strong, nullable) NSNumber *isLocalDataGuardEnabled; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Monday; /** - * Optional. This field indicates if auto scaling is enabled for the Autonomous - * Database storage. + * Saturday * - * Uses NSNumber of boolValue. + * Value: "SATURDAY" */ -@property(nonatomic, strong, nullable) NSNumber *isStorageAutoScalingEnabled; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Saturday; /** - * Required. The license type used for the Autonomous Database. + * Sunday * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LicenseType_BringYourOwnLicense - * Bring your own license (Value: "BRING_YOUR_OWN_LICENSE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LicenseType_LicenseIncluded - * License included part of offer (Value: "LICENSE_INCLUDED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LicenseType_LicenseTypeUnspecified - * Unspecified (Value: "LICENSE_TYPE_UNSPECIFIED") + * Value: "SUNDAY" */ -@property(nonatomic, copy, nullable) NSString *licenseType; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Sunday; /** - * Output only. The details of the current lifestyle state of the Autonomous - * Database. + * Thursday + * + * Value: "THURSDAY" */ -@property(nonatomic, copy, nullable) NSString *lifecycleDetails; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Thursday; /** - * Output only. This field indicates the maximum data loss limit for an - * Autonomous Database, in seconds. + * Tuesday * - * Uses NSNumber of intValue. + * Value: "TUESDAY" */ -@property(nonatomic, strong, nullable) NSNumber *localAdgAutoFailoverMaxDataLossLimit; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Tuesday; /** - * Output only. This field indicates the local disaster recovery (DR) type of - * an Autonomous Database. + * Wednesday * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LocalDisasterRecoveryType_Adg - * Autonomous Data Guard recovery. (Value: "ADG") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LocalDisasterRecoveryType_BackupBased - * Backup based recovery. (Value: "BACKUP_BASED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LocalDisasterRecoveryType_LocalDisasterRecoveryTypeUnspecified - * Default unspecified value. (Value: - * "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED") + * Value: "WEDNESDAY" */ -@property(nonatomic, copy, nullable) NSString *localDisasterRecoveryType; - -/** Output only. The details of the Autonomous Data Guard standby database. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseStandbySummary *localStandbyDb; - -/** Output only. The date and time when maintenance will begin. */ -@property(nonatomic, strong, nullable) GTLRDateTime *maintenanceBeginTime; +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_DaysOfWeek_Wednesday; -/** Output only. The date and time when maintenance will end. */ -@property(nonatomic, strong, nullable) GTLRDateTime *maintenanceEndTime; +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_MaintenanceWindow.months /** - * Optional. The maintenance schedule of the Autonomous Database. + * The month of April. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_MaintenanceScheduleType_Early - * An EARLY maintenance schedule patches the database before the regular - * scheduled maintenance. (Value: "EARLY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_MaintenanceScheduleType_MaintenanceScheduleTypeUnspecified - * Default unspecified value. (Value: - * "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_MaintenanceScheduleType_Regular - * A REGULAR maintenance schedule follows the normal maintenance cycle. - * (Value: "REGULAR") + * Value: "APRIL" */ -@property(nonatomic, copy, nullable) NSString *maintenanceScheduleType; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_April; /** - * Output only. The amount of memory enabled per ECPU, in gigabytes. + * The month of August. * - * Uses NSNumber of intValue. + * Value: "AUGUST" */ -@property(nonatomic, strong, nullable) NSNumber *memoryPerOracleComputeUnitGbs; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_August; /** - * Output only. The memory assigned to in-memory tables in an Autonomous - * Database. + * The month of December. * - * Uses NSNumber of intValue. + * Value: "DECEMBER" */ -@property(nonatomic, strong, nullable) NSNumber *memoryTableGbs; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_December; /** - * Optional. This field specifies if the Autonomous Database requires mTLS - * connections. + * The month of February. * - * Uses NSNumber of boolValue. + * Value: "FEBRUARY" */ -@property(nonatomic, strong, nullable) NSNumber *mtlsConnectionRequired; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_February; /** - * Optional. The national character set for the Autonomous Database. The - * default is AL16UTF16. + * The month of January. + * + * Value: "JANUARY" */ -@property(nonatomic, copy, nullable) NSString *nCharacterSet; - -/** Output only. The long term backup schedule of the Autonomous Database. */ -@property(nonatomic, strong, nullable) GTLRDateTime *nextLongTermBackupTime; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_January; /** - * Output only. OCID of the Autonomous Database. - * https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + * The month of July. + * + * Value: "JULY" */ -@property(nonatomic, copy, nullable) NSString *ocid; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_July; /** - * Output only. The Oracle Cloud Infrastructure link for the Autonomous - * Database. + * The month of June. + * + * Value: "JUNE" */ -@property(nonatomic, copy, nullable) NSString *ociUrl; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_June; /** - * Output only. This field indicates the current mode of the Autonomous - * Database. + * The month of March. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OpenMode_OpenModeUnspecified - * Default unspecified value. (Value: "OPEN_MODE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OpenMode_ReadOnly - * Read Only Mode (Value: "READ_ONLY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OpenMode_ReadWrite - * Read Write Mode (Value: "READ_WRITE") + * Value: "MARCH" */ -@property(nonatomic, copy, nullable) NSString *openMode; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_March; /** - * Output only. This field indicates the state of Operations Insights for the - * Autonomous Database. + * The month of May. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_Disabling - * Disabling status for operation insights. (Value: "DISABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_Enabled - * Enabled status for operation insights. (Value: "ENABLED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_Enabling - * Enabling status for operation insights. (Value: "ENABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_FailedDisabling - * Failed disabling status for operation insights. (Value: - * "FAILED_DISABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_FailedEnabling - * Failed enabling status for operation insights. (Value: - * "FAILED_ENABLING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_NotEnabled - * Not Enabled status for operation insights. (Value: "NOT_ENABLED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_OperationsInsightsStateUnspecified - * Default unspecified value. (Value: - * "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED") + * Value: "MAY" */ -@property(nonatomic, copy, nullable) NSString *operationsInsightsState; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_May; /** - * Output only. The list of OCIDs of standby databases located in Autonomous - * Data Guard remote regions that are associated with the source database. + * The unspecified month. + * + * Value: "MONTH_UNSPECIFIED" */ -@property(nonatomic, strong, nullable) NSArray *peerDbIds; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_MonthUnspecified; /** - * Output only. The permission level of the Autonomous Database. + * The month of November. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_PermissionLevel_PermissionLevelUnspecified - * Default unspecified value. (Value: "PERMISSION_LEVEL_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_PermissionLevel_Restricted - * Restricted mode allows access only by admin users. (Value: - * "RESTRICTED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_PermissionLevel_Unrestricted - * Normal access. (Value: "UNRESTRICTED") + * Value: "NOVEMBER" */ -@property(nonatomic, copy, nullable) NSString *permissionLevel; - -/** Output only. The private endpoint for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *privateEndpoint; - -/** Optional. The private endpoint IP address for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *privateEndpointIp; - -/** Optional. The private endpoint label for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *privateEndpointLabel; - +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_November; /** - * Output only. The refresh mode of the cloned Autonomous Database. + * The month of October. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableMode_Automatic - * AUTOMATIC indicates that the cloned database is automatically - * refreshed with data from the source Autonomous Database. (Value: - * "AUTOMATIC") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableMode_Manual - * MANUAL indicates that the cloned database is manually refreshed with - * data from the source Autonomous Database. (Value: "MANUAL") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableMode_RefreshableModeUnspecified - * The default unspecified value. (Value: "REFRESHABLE_MODE_UNSPECIFIED") + * Value: "OCTOBER" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_October; +/** + * The month of September. + * + * Value: "SEPTEMBER" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Months_September; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_MaintenanceWindow.patchingMode + +/** + * The non-rolling maintenance method first updates your storage servers at the + * same time, then your database servers at the same time. + * + * Value: "NON_ROLLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_PatchingMode_NonRolling; +/** + * Default unspecified value. + * + * Value: "PATCHING_MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_PatchingMode_PatchingModeUnspecified; +/** + * Updates the Cloud Exadata database server hosts in a rolling fashion. + * + * Value: "ROLLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_PatchingMode_Rolling; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_MaintenanceWindow.preference + +/** + * Custom preference. + * + * Value: "CUSTOM_PREFERENCE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Preference_CustomPreference; +/** + * Default unspecified value. + * + * Value: "MAINTENANCE_WINDOW_PREFERENCE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Preference_MaintenanceWindowPreferenceUnspecified; +/** + * No preference. + * + * Value: "NO_PREFERENCE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_MaintenanceWindow_Preference_NoPreference; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_OdbNetwork.state + +/** + * Indicates that the resource is in available state. + * + * Value: "AVAILABLE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Available; +/** + * Indicates that the resource is in failed state. + * + * Value: "FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Failed; +/** + * Indicates that the resource is in provisioning state. + * + * Value: "PROVISIONING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Provisioning; +/** + * Default unspecified value. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_StateUnspecified; +/** + * Indicates that the resource is in terminating state. + * + * Value: "TERMINATING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbNetwork_State_Terminating; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_OdbSubnet.purpose + +/** + * Subnet to be used for backup. + * + * Value: "BACKUP_SUBNET" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_Purpose_BackupSubnet; +/** + * Subnet to be used for client connections. + * + * Value: "CLIENT_SUBNET" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_Purpose_ClientSubnet; +/** + * Default unspecified value. + * + * Value: "PURPOSE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_Purpose_PurposeUnspecified; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_OdbSubnet.state + +/** + * Indicates that the resource is in available state. + * + * Value: "AVAILABLE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Available; +/** + * Indicates that the resource is in failed state. + * + * Value: "FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Failed; +/** + * Indicates that the resource is in provisioning state. + * + * Value: "PROVISIONING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Provisioning; +/** + * Default unspecified value. + * + * Value: "STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_StateUnspecified; +/** + * Indicates that the resource is in terminating state. + * + * Value: "TERMINATING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_OdbSubnet_State_Terminating; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_PluggableDatabaseNodeLevelDetails.openMode + +/** + * The pluggable database is migrated. + * + * Value: "MIGRATE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_Migrate; +/** + * The pluggable database is mounted. + * + * Value: "MOUNTED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_Mounted; +/** + * The open mode is unspecified. + * + * Value: "PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_PluggableDatabaseOpenModeUnspecified; +/** + * The pluggable database is opened in read-only mode. + * + * Value: "READ_ONLY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_ReadOnly; +/** + * The pluggable database is opened in read-write mode. + * + * Value: "READ_WRITE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_ReadWrite; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_PluggableDatabaseProperties.lifecycleState + +/** + * The pluggable database is available. + * + * Value: "AVAILABLE" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Available; +/** + * The pluggable database is backing up. + * + * Value: "BACKUP_IN_PROGRESS" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_BackupInProgress; +/** + * The pluggable database is disabled. + * + * Value: "DISABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Disabled; +/** + * The pluggable database is in a failed state. + * + * Value: "FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Failed; +/** + * The lifecycle state is unspecified. + * + * Value: "PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_PluggableDatabaseLifecycleStateUnspecified; +/** + * The pluggable database is provisioning. + * + * Value: "PROVISIONING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Provisioning; +/** + * The pluggable database is refreshing. + * + * Value: "REFRESHING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Refreshing; +/** + * The pluggable database is relocated. + * + * Value: "RELOCATED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Relocated; +/** + * The pluggable database is relocating. + * + * Value: "RELOCATING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Relocating; +/** + * The pluggable database restore failed. + * + * Value: "RESTORE_FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_RestoreFailed; +/** + * The pluggable database is restoring. + * + * Value: "RESTORE_IN_PROGRESS" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_RestoreInProgress; +/** + * The pluggable database is terminated. + * + * Value: "TERMINATED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Terminated; +/** + * The pluggable database is terminating. + * + * Value: "TERMINATING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Terminating; +/** + * The pluggable database is updating. + * + * Value: "UPDATING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Updating; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_PluggableDatabaseProperties.operationsInsightsState + +/** + * Operations Insights is disabling. + * + * Value: "DISABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Disabling; +/** + * Operations Insights is enabled. + * + * Value: "ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Enabled; +/** + * Operations Insights is enabling. + * + * Value: "ENABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Enabling; +/** + * Operations Insights failed to disable. + * + * Value: "FAILED_DISABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_FailedDisabling; +/** + * Operations Insights failed to enable. + * + * Value: "FAILED_ENABLING" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_FailedEnabling; +/** + * Operations Insights is not enabled. + * + * Value: "NOT_ENABLED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_NotEnabled; +/** + * The status is not specified. + * + * Value: "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_OperationsInsightsStateUnspecified; + +// ---------------------------------------------------------------------------- +// GTLROracleDatabase_ScheduledOperationDetails.dayOfWeek + +/** + * The day of the week is unspecified. + * + * Value: "DAY_OF_WEEK_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_DayOfWeekUnspecified; +/** + * Friday + * + * Value: "FRIDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Friday; +/** + * Monday + * + * Value: "MONDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Monday; +/** + * Saturday + * + * Value: "SATURDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Saturday; +/** + * Sunday + * + * Value: "SUNDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Sunday; +/** + * Thursday + * + * Value: "THURSDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Thursday; +/** + * Tuesday + * + * Value: "TUESDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Tuesday; +/** + * Wednesday + * + * Value: "WEDNESDAY" + */ +FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails_DayOfWeek_Wednesday; + +/** + * A list of all connection strings that can be used to connect to the + * Autonomous Database. + */ +@interface GTLROracleDatabase_AllConnectionStrings : GTLRObject + +/** + * Output only. The database service provides the highest level of resources to + * each SQL statement. + */ +@property(nonatomic, copy, nullable) NSString *high; + +/** + * Output only. The database service provides the least level of resources to + * each SQL statement. + */ +@property(nonatomic, copy, nullable) NSString *low; + +/** + * Output only. The database service provides a lower level of resources to + * each SQL statement. + */ +@property(nonatomic, copy, nullable) NSString *medium; + +@end + + +/** + * Details of the Autonomous Database resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ + */ +@interface GTLROracleDatabase_AutonomousDatabase : GTLRObject + +/** Optional. The password for the default ADMIN user. */ +@property(nonatomic, copy, nullable) NSString *adminPassword; + +/** Optional. The subnet CIDR range for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *cidr; + +/** + * Output only. The date and time that the Autonomous Database was created. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Optional. The name of the Autonomous Database. The database name must be + * unique in the project. The name must begin with a letter and can contain a + * maximum of 30 alphanumeric characters. + */ +@property(nonatomic, copy, nullable) NSString *database; + +/** + * Output only. List of supported GCP region to clone the Autonomous Database + * for disaster recovery. Format: `project/{project}/locations/{location}`. + */ +@property(nonatomic, strong, nullable) NSArray *disasterRecoverySupportedLocations; + +/** + * Optional. The display name for the Autonomous Database. The name does not + * have to be unique within your project. + */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** + * Output only. The ID of the subscription entitlement associated with the + * Autonomous Database. + */ +@property(nonatomic, copy, nullable) NSString *entitlementId; + +/** Optional. The labels or tags associated with the Autonomous Database. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabase_Labels *labels; + +/** + * Identifier. The name of the Autonomous Database resource in the following + * format: + * projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. The name of the VPC network used by the Autonomous Database in the + * following format: projects/{project}/global/networks/{network} + */ +@property(nonatomic, copy, nullable) NSString *network; + +/** + * Optional. The name of the OdbNetwork associated with the Autonomous + * Database. Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network} It is + * optional but if specified, this should match the parent ODBNetwork of the + * OdbSubnet. + */ +@property(nonatomic, copy, nullable) NSString *odbNetwork; + +/** + * Optional. The name of the OdbSubnet associated with the Autonomous Database. + * Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + */ +@property(nonatomic, copy, nullable) NSString *odbSubnet; + +/** + * Output only. The peer Autonomous Database names of the given Autonomous + * Database. + */ +@property(nonatomic, strong, nullable) NSArray *peerAutonomousDatabases; + +/** Optional. The properties of the Autonomous Database. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseProperties *properties; + +/** + * Optional. The source Autonomous Database configuration for the standby + * Autonomous Database. The source Autonomous Database is configured while + * creating the Peer Autonomous Database and can't be updated after creation. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_SourceConfig *sourceConfig; + +@end + + +/** + * Optional. The labels or tags associated with the Autonomous Database. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLROracleDatabase_AutonomousDatabase_Labels : GTLRObject +@end + + +/** + * Oracle APEX Application Development. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex + */ +@interface GTLROracleDatabase_AutonomousDatabaseApex : GTLRObject + +/** Output only. The Oracle APEX Application Development version. */ +@property(nonatomic, copy, nullable) NSString *apexVersion; + +/** Output only. The Oracle REST Data Services (ORDS) version. */ +@property(nonatomic, copy, nullable) NSString *ordsVersion; + +@end + + +/** + * Details of the Autonomous Database Backup resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/ + */ +@interface GTLROracleDatabase_AutonomousDatabaseBackup : GTLRObject + +/** + * Required. The name of the Autonomous Database resource for which the backup + * is being created. Format: + * projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + */ +@property(nonatomic, copy, nullable) NSString *autonomousDatabase; + +/** + * Optional. User friendly name for the Backup. The name does not have to be + * unique. + */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** Optional. labels or tags associated with the resource. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseBackup_Labels *labels; + +/** + * Identifier. The name of the Autonomous Database Backup resource with the + * format: + * projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Optional. Various properties of the backup. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseBackupProperties *properties; + +@end + + +/** + * Optional. labels or tags associated with the resource. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLROracleDatabase_AutonomousDatabaseBackup_Labels : GTLRObject +@end + + +/** + * Properties of the Autonomous Database Backup resource. + */ +@interface GTLROracleDatabase_AutonomousDatabaseBackupProperties : GTLRObject + +/** Output only. Timestamp until when the backup will be available. */ +@property(nonatomic, strong, nullable) GTLRDateTime *availableTillTime; + +/** Output only. The OCID of the compartment. */ +@property(nonatomic, copy, nullable) NSString *compartmentId; + +/** + * Output only. The quantity of data in the database, in terabytes. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *databaseSizeTb; + +/** Output only. A valid Oracle Database version for Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *dbVersion; + +/** Output only. The date and time the backup completed. */ +@property(nonatomic, strong, nullable) GTLRDateTime *endTime; + +/** + * Output only. Indicates if the backup is automatic or user initiated. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isAutomaticBackup; + +/** + * Output only. Indicates if the backup is long term backup. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isLongTermBackup; + +/** + * Output only. Indicates if the backup can be used to restore the Autonomous + * Database. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isRestorable; + +/** Optional. The OCID of the key store of Oracle Vault. */ +@property(nonatomic, copy, nullable) NSString *keyStoreId; + +/** Optional. The wallet name for Oracle Key Vault. */ +@property(nonatomic, copy, nullable) NSString *keyStoreWallet; + +/** + * Optional. The OCID of the key container that is used as the master + * encryption key in database transparent data encryption (TDE) operations. + */ +@property(nonatomic, copy, nullable) NSString *kmsKeyId; + +/** + * Optional. The OCID of the key container version that is used in database + * transparent data encryption (TDE) operations KMS Key can have multiple key + * versions. If none is specified, the current key version (latest) of the Key + * Id is used for the operation. Autonomous Database Serverless does not use + * key versions, hence is not applicable for Autonomous Database Serverless + * instances. + */ +@property(nonatomic, copy, nullable) NSString *kmsKeyVersionId; + +/** Output only. Additional information about the current lifecycle state. */ +@property(nonatomic, copy, nullable) NSString *lifecycleDetails; + +/** + * Output only. The lifecycle state of the backup. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Active + * Indicates that the resource is in active state. (Value: "ACTIVE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Creating + * Indicates that the resource is in creating state. (Value: "CREATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Deleted + * Indicates that the resource is in deleted state. (Value: "DELETED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Deleting + * Indicates that the resource is in deleting state. (Value: "DELETING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Failed + * Indicates that the resource is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_StateUnspecified + * Default unspecified value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_LifecycleState_Updating + * Indicates that the resource is in updating state. (Value: "UPDATING") + */ +@property(nonatomic, copy, nullable) NSString *lifecycleState; + +/** + * Output only. OCID of the Autonomous Database backup. + * https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + */ +@property(nonatomic, copy, nullable) NSString *ocid; + +/** + * Optional. Retention period in days for the backup. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *retentionPeriodDays; + +/** + * Output only. The backup size in terabytes. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *sizeTb; + +/** Output only. The date and time the backup started. */ +@property(nonatomic, strong, nullable) GTLRDateTime *startTime; + +/** + * Output only. The type of the backup. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_Full + * Full backups. (Value: "FULL") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_Incremental + * Incremental backups. (Value: "INCREMENTAL") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_LongTerm + * Long term backups. (Value: "LONG_TERM") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseBackupProperties_Type_TypeUnspecified + * Default unspecified value. (Value: "TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *type; + +/** Optional. The OCID of the vault. */ +@property(nonatomic, copy, nullable) NSString *vaultId; + +@end + + +/** + * Details of the Autonomous Database character set resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ + */ +@interface GTLROracleDatabase_AutonomousDatabaseCharacterSet : GTLRObject + +/** + * Output only. The character set name for the Autonomous Database which is the + * ID in the resource name. + */ +@property(nonatomic, copy, nullable) NSString *characterSet; + +/** + * Output only. The character set type for the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseCharacterSet_CharacterSetType_CharacterSetTypeUnspecified + * Character set type is not specified. (Value: + * "CHARACTER_SET_TYPE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseCharacterSet_CharacterSetType_Database + * Character set type is set to database. (Value: "DATABASE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseCharacterSet_CharacterSetType_National + * Character set type is set to national. (Value: "NATIONAL") + */ +@property(nonatomic, copy, nullable) NSString *characterSetType; + +/** + * Identifier. The name of the Autonomous Database Character Set resource in + * the following format: + * projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set} + */ +@property(nonatomic, copy, nullable) NSString *name; + +@end + + +/** + * The connection string used to connect to the Autonomous Database. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings + */ +@interface GTLROracleDatabase_AutonomousDatabaseConnectionStrings : GTLRObject + +/** + * Output only. Returns all connection strings that can be used to connect to + * the Autonomous Database. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AllConnectionStrings *allConnectionStrings; + +/** + * Output only. The database service provides the least level of resources to + * each SQL statement, but supports the most number of concurrent SQL + * statements. + */ +@property(nonatomic, copy, nullable) NSString *dedicated; + +/** + * Output only. The database service provides the highest level of resources to + * each SQL statement. + */ +@property(nonatomic, copy, nullable) NSString *high; + +/** + * Output only. The database service provides the least level of resources to + * each SQL statement. + */ +@property(nonatomic, copy, nullable) NSString *low; + +/** + * Output only. The database service provides a lower level of resources to + * each SQL statement. + */ +@property(nonatomic, copy, nullable) NSString *medium; + +/** + * Output only. A list of connection string profiles to allow clients to group, + * filter, and select values based on the structured metadata. + */ +@property(nonatomic, strong, nullable) NSArray *profiles; + +@end + + +/** + * The URLs for accessing Oracle Application Express (APEX) and SQL Developer + * Web with a browser from a Compute instance. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls + */ +@interface GTLROracleDatabase_AutonomousDatabaseConnectionUrls : GTLRObject + +/** Output only. Oracle Application Express (APEX) URL. */ +@property(nonatomic, copy, nullable) NSString *apexUri; + +/** + * Output only. The URL of the Database Transforms for the Autonomous Database. + */ +@property(nonatomic, copy, nullable) NSString *databaseTransformsUri; + +/** Output only. The URL of the Graph Studio for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *graphStudioUri; + +/** + * Output only. The URL of the Oracle Machine Learning (OML) Notebook for the + * Autonomous Database. + */ +@property(nonatomic, copy, nullable) NSString *machineLearningNotebookUri; + +/** + * Output only. The URL of Machine Learning user management the Autonomous + * Database. + */ +@property(nonatomic, copy, nullable) NSString *machineLearningUserManagementUri; + +/** Output only. The URL of the MongoDB API for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *mongoDbUri; + +/** + * Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for + * the Autonomous Database. + */ +@property(nonatomic, copy, nullable) NSString *ordsUri; + +/** + * Output only. The URL of the Oracle SQL Developer Web for the Autonomous + * Database. + */ +@property(nonatomic, copy, nullable) NSString *sqlDevWebUri; + +@end + + +/** + * The properties of an Autonomous Database. + */ +@interface GTLROracleDatabase_AutonomousDatabaseProperties : GTLRObject + +/** + * Output only. The amount of storage currently being used for user and system + * data, in terabytes. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *actualUsedDataStorageSizeTb; + +/** + * Output only. The amount of storage currently allocated for the database + * tables and billed for, rounded up in terabytes. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *allocatedStorageSizeTb; + +/** + * Optional. The list of allowlisted IP addresses for the Autonomous Database. + */ +@property(nonatomic, strong, nullable) NSArray *allowlistedIps; + +/** Output only. The details for the Oracle APEX Application Development. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseApex *apexDetails; + +/** + * Output only. This field indicates the status of Data Guard and Access + * control for the Autonomous Database. The field's value is null if Data Guard + * is disabled or Access Control is disabled. The field's value is TRUE if both + * Data Guard and Access Control are enabled, and the Autonomous Database is + * using primary IP access control list (ACL) for standby. The field's value is + * FALSE if both Data Guard and Access Control are enabled, and the Autonomous + * Database is using a different IP access control list (ACL) for standby + * compared to primary. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *arePrimaryAllowlistedIpsUsed; + +/** Output only. The Autonomous Container Database OCID. */ +@property(nonatomic, copy, nullable) NSString *autonomousContainerDatabaseId; + +/** + * Output only. The list of available Oracle Database upgrade versions for an + * Autonomous Database. + */ +@property(nonatomic, strong, nullable) NSArray *availableUpgradeVersions; + +/** + * Optional. The retention period for the Autonomous Database. This field is + * specified in days, can range from 1 day to 60 days, and has a default value + * of 60 days. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *backupRetentionPeriodDays; + +/** + * Optional. The character set for the Autonomous Database. The default is + * AL32UTF8. + */ +@property(nonatomic, copy, nullable) NSString *characterSet; + +/** + * Optional. The number of compute servers for the Autonomous Database. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *computeCount; + +/** + * Output only. The connection strings used to connect to an Autonomous + * Database. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseConnectionStrings *connectionStrings; + +/** Output only. The Oracle Connection URLs for an Autonomous Database. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseConnectionUrls *connectionUrls; + +/** + * Optional. The number of CPU cores to be made available to the database. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *cpuCoreCount; + +/** Optional. The list of customer contacts. */ +@property(nonatomic, strong, nullable) NSArray *customerContacts; + +/** + * Output only. The current state of database management for the Autonomous + * Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_DatabaseManagementStateUnspecified + * Default unspecified value. (Value: + * "DATABASE_MANAGEMENT_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_Disabling + * Disabling Database Management state (Value: "DISABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_Enabled + * Enabled Database Management state (Value: "ENABLED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_Enabling + * Enabling Database Management state (Value: "ENABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_FailedDisabling + * Failed disabling Database Management state (Value: "FAILED_DISABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_FailedEnabling + * Failed enabling Database Management state (Value: "FAILED_ENABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DatabaseManagementState_NotEnabled + * Not Enabled Database Management state (Value: "NOT_ENABLED") + */ +@property(nonatomic, copy, nullable) NSString *databaseManagementState; + +/** + * Output only. The date and time the Autonomous Data Guard role was changed + * for the standby Autonomous Database. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *dataGuardRoleChangedTime; + +/** + * Output only. The current state of the Data Safe registration for the + * Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_DataSafeStateUnspecified + * Default unspecified value. (Value: "DATA_SAFE_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Deregistering + * Deregistering data safe state. (Value: "DEREGISTERING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Failed + * Failed data safe state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_NotRegistered + * Not registered data safe state. (Value: "NOT_REGISTERED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Registered + * Registered data safe state. (Value: "REGISTERED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DataSafeState_Registering + * Registering data safe state. (Value: "REGISTERING") + */ +@property(nonatomic, copy, nullable) NSString *dataSafeState; + +/** + * Optional. The size of the data stored in the database, in gigabytes. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeGb; + +/** + * Optional. The size of the data stored in the database, in terabytes. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeTb; + +/** + * Optional. The edition of the Autonomous Databases. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbEdition_DatabaseEditionUnspecified + * Default unspecified value. (Value: "DATABASE_EDITION_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbEdition_EnterpriseEdition + * Enterprise Database Edition (Value: "ENTERPRISE_EDITION") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbEdition_StandardEdition + * Standard Database Edition (Value: "STANDARD_EDITION") + */ +@property(nonatomic, copy, nullable) NSString *dbEdition; + +/** Optional. The Oracle Database version for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *dbVersion; + +/** + * Required. The workload type of the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Ajd + * Autonomous JSON Database. (Value: "AJD") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Apex + * Autonomous Database with the Oracle APEX Application Development + * workload type. (Value: "APEX") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_DbWorkloadUnspecified + * Default unspecified value. (Value: "DB_WORKLOAD_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Dw + * Autonomous Data Warehouse database. (Value: "DW") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_DbWorkload_Oltp + * Autonomous Transaction Processing database. (Value: "OLTP") + */ +@property(nonatomic, copy, nullable) NSString *dbWorkload; + +/** + * Output only. The date and time the Disaster Recovery role was changed for + * the standby Autonomous Database. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *disasterRecoveryRoleChangedTime; + +/** + * Optional. The encryption key used to encrypt the Autonomous Database. + * Updating this field will add a new entry in the + * `encryption_key_history_entries` field with the former version. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_EncryptionKey *encryptionKey; + +/** + * Output only. The history of the encryption keys used to encrypt the + * Autonomous Database. + */ +@property(nonatomic, strong, nullable) NSArray *encryptionKeyHistoryEntries; + +/** + * Output only. This field indicates the number of seconds of data loss during + * a Data Guard failover. + */ +@property(nonatomic, strong, nullable) GTLRDuration *failedDataRecoveryDuration; + +/** + * Optional. This field indicates if auto scaling is enabled for the Autonomous + * Database CPU core count. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isAutoScalingEnabled; + +/** + * Output only. This field indicates whether the Autonomous Database has local + * (in-region) Data Guard enabled. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isLocalDataGuardEnabled; + +/** + * Optional. This field indicates if auto scaling is enabled for the Autonomous + * Database storage. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isStorageAutoScalingEnabled; + +/** + * Required. The license type used for the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LicenseType_BringYourOwnLicense + * Bring your own license (Value: "BRING_YOUR_OWN_LICENSE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LicenseType_LicenseIncluded + * License included part of offer (Value: "LICENSE_INCLUDED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LicenseType_LicenseTypeUnspecified + * Unspecified (Value: "LICENSE_TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *licenseType; + +/** + * Output only. The details of the current lifestyle state of the Autonomous + * Database. + */ +@property(nonatomic, copy, nullable) NSString *lifecycleDetails; + +/** + * Output only. This field indicates the maximum data loss limit for an + * Autonomous Database, in seconds. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *localAdgAutoFailoverMaxDataLossLimit; + +/** + * Output only. This field indicates the local disaster recovery (DR) type of + * an Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LocalDisasterRecoveryType_Adg + * Autonomous Data Guard recovery. (Value: "ADG") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LocalDisasterRecoveryType_BackupBased + * Backup based recovery. (Value: "BACKUP_BASED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_LocalDisasterRecoveryType_LocalDisasterRecoveryTypeUnspecified + * Default unspecified value. (Value: + * "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *localDisasterRecoveryType; + +/** Output only. The details of the Autonomous Data Guard standby database. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_AutonomousDatabaseStandbySummary *localStandbyDb; + +/** Output only. The date and time when maintenance will begin. */ +@property(nonatomic, strong, nullable) GTLRDateTime *maintenanceBeginTime; + +/** Output only. The date and time when maintenance will end. */ +@property(nonatomic, strong, nullable) GTLRDateTime *maintenanceEndTime; + +/** + * Optional. The maintenance schedule of the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_MaintenanceScheduleType_Early + * An EARLY maintenance schedule patches the database before the regular + * scheduled maintenance. (Value: "EARLY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_MaintenanceScheduleType_MaintenanceScheduleTypeUnspecified + * Default unspecified value. (Value: + * "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_MaintenanceScheduleType_Regular + * A REGULAR maintenance schedule follows the normal maintenance cycle. + * (Value: "REGULAR") + */ +@property(nonatomic, copy, nullable) NSString *maintenanceScheduleType; + +/** + * Output only. The amount of memory enabled per ECPU, in gigabytes. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *memoryPerOracleComputeUnitGbs; + +/** + * Output only. The memory assigned to in-memory tables in an Autonomous + * Database. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *memoryTableGbs; + +/** + * Optional. This field specifies if the Autonomous Database requires mTLS + * connections. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *mtlsConnectionRequired; + +/** + * Optional. The national character set for the Autonomous Database. The + * default is AL16UTF16. + */ +@property(nonatomic, copy, nullable) NSString *nCharacterSet; + +/** Output only. The long term backup schedule of the Autonomous Database. */ +@property(nonatomic, strong, nullable) GTLRDateTime *nextLongTermBackupTime; + +/** + * Output only. OCID of the Autonomous Database. + * https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + */ +@property(nonatomic, copy, nullable) NSString *ocid; + +/** + * Output only. The Oracle Cloud Infrastructure link for the Autonomous + * Database. + */ +@property(nonatomic, copy, nullable) NSString *ociUrl; + +/** + * Output only. This field indicates the current mode of the Autonomous + * Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OpenMode_OpenModeUnspecified + * Default unspecified value. (Value: "OPEN_MODE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OpenMode_ReadOnly + * Read Only Mode (Value: "READ_ONLY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OpenMode_ReadWrite + * Read Write Mode (Value: "READ_WRITE") + */ +@property(nonatomic, copy, nullable) NSString *openMode; + +/** + * Output only. This field indicates the state of Operations Insights for the + * Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_Disabling + * Disabling status for operation insights. (Value: "DISABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_Enabled + * Enabled status for operation insights. (Value: "ENABLED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_Enabling + * Enabling status for operation insights. (Value: "ENABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_FailedDisabling + * Failed disabling status for operation insights. (Value: + * "FAILED_DISABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_FailedEnabling + * Failed enabling status for operation insights. (Value: + * "FAILED_ENABLING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_NotEnabled + * Not Enabled status for operation insights. (Value: "NOT_ENABLED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_OperationsInsightsState_OperationsInsightsStateUnspecified + * Default unspecified value. (Value: + * "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *operationsInsightsState; + +/** + * Output only. The list of OCIDs of standby databases located in Autonomous + * Data Guard remote regions that are associated with the source database. + */ +@property(nonatomic, strong, nullable) NSArray *peerDbIds; + +/** + * Output only. The permission level of the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_PermissionLevel_PermissionLevelUnspecified + * Default unspecified value. (Value: "PERMISSION_LEVEL_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_PermissionLevel_Restricted + * Restricted mode allows access only by admin users. (Value: + * "RESTRICTED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_PermissionLevel_Unrestricted + * Normal access. (Value: "UNRESTRICTED") + */ +@property(nonatomic, copy, nullable) NSString *permissionLevel; + +/** Output only. The private endpoint for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *privateEndpoint; + +/** Optional. The private endpoint IP address for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *privateEndpointIp; + +/** Optional. The private endpoint label for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *privateEndpointLabel; + +/** + * Output only. The refresh mode of the cloned Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableMode_Automatic + * AUTOMATIC indicates that the cloned database is automatically + * refreshed with data from the source Autonomous Database. (Value: + * "AUTOMATIC") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableMode_Manual + * MANUAL indicates that the cloned database is manually refreshed with + * data from the source Autonomous Database. (Value: "MANUAL") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableMode_RefreshableModeUnspecified + * The default unspecified value. (Value: "REFRESHABLE_MODE_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *refreshableMode; /** - * Output only. The refresh State of the clone. + * Output only. The refresh State of the clone. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableState_NotRefreshing + * Not refreshed (Value: "NOT_REFRESHING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableState_RefreshableStateUnspecified + * Default unspecified value. (Value: "REFRESHABLE_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableState_Refreshing + * Refreshing (Value: "REFRESHING") + */ +@property(nonatomic, copy, nullable) NSString *refreshableState; + +/** + * Output only. The Data Guard role of the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_BackupCopy + * Backup copy role (Value: "BACKUP_COPY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_DisabledStandby + * Disabled standby role (Value: "DISABLED_STANDBY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_Primary + * Primary role (Value: "PRIMARY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_RoleUnspecified + * Default unspecified value. (Value: "ROLE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_SnapshotStandby + * Snapshot standby role (Value: "SNAPSHOT_STANDBY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_Standby + * Standby role (Value: "STANDBY") + */ +@property(nonatomic, copy, nullable) NSString *role; + +/** + * Output only. The list and details of the scheduled operations of the + * Autonomous Database. + */ +@property(nonatomic, strong, nullable) NSArray *scheduledOperationDetails; + +/** Optional. The ID of the Oracle Cloud Infrastructure vault secret. */ +@property(nonatomic, copy, nullable) NSString *secretId; + +/** + * Output only. An Oracle-managed Google Cloud service account on which + * customers can grant roles to access resources in the customer project. + */ +@property(nonatomic, copy, nullable) NSString *serviceAgentEmail; + +/** Output only. The SQL Web Developer URL for the Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *sqlWebDeveloperUrl; + +/** + * Output only. The current lifecycle state of the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Available + * Indicates that the Autonomous Database is in available state. (Value: + * "AVAILABLE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_AvailableNeedsAttention + * Indicates that the Autonomous Database is available but needs + * attention state. (Value: "AVAILABLE_NEEDS_ATTENTION") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_BackupInProgress + * Indicates that the Autonomous Database backup is in progress. (Value: + * "BACKUP_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Inaccessible + * Indicates that the Autonomous Database is in inaccessible state. + * (Value: "INACCESSIBLE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_MaintenanceInProgress + * Indicates that the Autonomous Database's maintenance is in progress + * state. (Value: "MAINTENANCE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Provisioning + * Indicates that the Autonomous Database is in provisioning state. + * (Value: "PROVISIONING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Recreating + * Indicates that the Autonomous Database is in recreating state. (Value: + * "RECREATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Restarting + * Indicates that the Autonomous Database is in restarting state. (Value: + * "RESTARTING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_RestoreFailed + * Indicates that the Autonomous Database failed to restore. (Value: + * "RESTORE_FAILED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_RestoreInProgress + * Indicates that the Autonomous Database restore is in progress. (Value: + * "RESTORE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_RoleChangeInProgress + * Indicates that the Autonomous Database's role change is in progress + * state. (Value: "ROLE_CHANGE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_ScaleInProgress + * Indicates that the Autonomous Database scale is in progress. (Value: + * "SCALE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Standby + * Indicates that the Autonomous Database is in standby state. (Value: + * "STANDBY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Starting + * Indicates that the Autonomous Database is in starting state. (Value: + * "STARTING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_StateUnspecified + * Default unspecified value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Stopped + * Indicates that the Autonomous Database is in stopped state. (Value: + * "STOPPED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Stopping + * Indicates that the Autonomous Database is in stopping state. (Value: + * "STOPPING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Terminated + * Indicates that the Autonomous Database is in terminated state. (Value: + * "TERMINATED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Terminating + * Indicates that the Autonomous Database is in terminating state. + * (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Unavailable + * Indicates that the Autonomous Database is in unavailable state. + * (Value: "UNAVAILABLE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Updating + * Indicates that the Autonomous Database is in updating state. (Value: + * "UPDATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Upgrading + * Indicates that the Autonomous Database is in upgrading state. (Value: + * "UPGRADING") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** + * Output only. The list of available regions that can be used to create a + * clone for the Autonomous Database. + */ +@property(nonatomic, strong, nullable) NSArray *supportedCloneRegions; + +/** + * Output only. The storage space used by automatic backups of Autonomous + * Database, in gigabytes. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalAutoBackupStorageSizeGbs; + +/** + * Output only. The storage space used by Autonomous Database, in gigabytes. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *usedDataStorageSizeTbs; + +/** Optional. The ID of the Oracle Cloud Infrastructure vault. */ +@property(nonatomic, copy, nullable) NSString *vaultId; + +@end + + +/** + * Autonomous Data Guard standby database details. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary + */ +@interface GTLROracleDatabase_AutonomousDatabaseStandbySummary : GTLRObject + +/** + * Output only. The date and time the Autonomous Data Guard role was switched + * for the standby Autonomous Database. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *dataGuardRoleChangedTime; + +/** + * Output only. The date and time the Disaster Recovery role was switched for + * the standby Autonomous Database. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *disasterRecoveryRoleChangedTime; + +/** + * Output only. The amount of time, in seconds, that the data of the standby + * database lags in comparison to the data of the primary database. + */ +@property(nonatomic, strong, nullable) GTLRDuration *lagTimeDuration; + +/** + * Output only. The additional details about the current lifecycle state of the + * Autonomous Database. + */ +@property(nonatomic, copy, nullable) NSString *lifecycleDetails; + +/** + * Output only. The current lifecycle state of the Autonomous Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Available + * Indicates that the Autonomous Database is in available state. (Value: + * "AVAILABLE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_AvailableNeedsAttention + * Indicates that the Autonomous Database is available but needs + * attention state. (Value: "AVAILABLE_NEEDS_ATTENTION") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_BackupInProgress + * Indicates that the Autonomous Database backup is in progress. (Value: + * "BACKUP_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Inaccessible + * Indicates that the Autonomous Database is in inaccessible state. + * (Value: "INACCESSIBLE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_MaintenanceInProgress + * Indicates that the Autonomous Database's maintenance is in progress + * state. (Value: "MAINTENANCE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Provisioning + * Indicates that the Autonomous Database is in provisioning state. + * (Value: "PROVISIONING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Recreating + * Indicates that the Autonomous Database is in recreating state. (Value: + * "RECREATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Restarting + * Indicates that the Autonomous Database is in restarting state. (Value: + * "RESTARTING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_RestoreFailed + * Indicates that the Autonomous Database failed to restore. (Value: + * "RESTORE_FAILED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_RestoreInProgress + * Indicates that the Autonomous Database restore is in progress. (Value: + * "RESTORE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_RoleChangeInProgress + * Indicates that the Autonomous Database's role change is in progress + * state. (Value: "ROLE_CHANGE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_ScaleInProgress + * Indicates that the Autonomous Database scale is in progress. (Value: + * "SCALE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Standby + * Indicates that the Autonomous Database is in standby state. (Value: + * "STANDBY") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Starting + * Indicates that the Autonomous Database is in starting state. (Value: + * "STARTING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_StateUnspecified + * Default unspecified value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Stopped + * Indicates that the Autonomous Database is in stopped state. (Value: + * "STOPPED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Stopping + * Indicates that the Autonomous Database is in stopping state. (Value: + * "STOPPING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Terminated + * Indicates that the Autonomous Database is in terminated state. (Value: + * "TERMINATED") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Terminating + * Indicates that the Autonomous Database is in terminating state. + * (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Unavailable + * Indicates that the Autonomous Database is in unavailable state. + * (Value: "UNAVAILABLE") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Updating + * Indicates that the Autonomous Database is in updating state. (Value: + * "UPDATING") + * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Upgrading + * Indicates that the Autonomous Database is in upgrading state. (Value: + * "UPGRADING") + */ +@property(nonatomic, copy, nullable) NSString *state; + +@end + + +/** + * Details of the Autonomous Database version. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/ + */ +@interface GTLROracleDatabase_AutonomousDbVersion : GTLRObject + +/** + * Output only. The Autonomous Database workload type. + * + * Likely values: + * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Ajd Autonomous + * JSON Database. (Value: "AJD") + * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Apex Autonomous + * Database with the Oracle APEX Application Development workload type. + * (Value: "APEX") + * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_DbWorkloadUnspecified + * Default unspecified value. (Value: "DB_WORKLOAD_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Dw Autonomous + * Data Warehouse database. (Value: "DW") + * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Oltp Autonomous + * Transaction Processing database. (Value: "OLTP") + */ +@property(nonatomic, copy, nullable) NSString *dbWorkload; + +/** + * Identifier. The name of the Autonomous Database Version resource with the + * format: + * projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Output only. An Oracle Database version for Autonomous Database. */ +@property(nonatomic, copy, nullable) NSString *version; + +/** + * Output only. A URL that points to a detailed description of the Autonomous + * Database version. + */ +@property(nonatomic, copy, nullable) NSString *workloadUri; + +@end + + +/** + * The details of the database backup destination. + */ +@interface GTLROracleDatabase_BackupDestinationDetails : GTLRObject + +/** + * Optional. The type of the database backup destination. + * + * Likely values: + * @arg @c kGTLROracleDatabase_BackupDestinationDetails_Type_BackupDestinationTypeUnspecified + * Default unspecified value. (Value: + * "BACKUP_DESTINATION_TYPE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_BackupDestinationDetails_Type_Dbrs Backup + * destination type is DBRS. (Value: "DBRS") + * @arg @c kGTLROracleDatabase_BackupDestinationDetails_Type_Local Backup + * destination type is Local. (Value: "LOCAL") + * @arg @c kGTLROracleDatabase_BackupDestinationDetails_Type_Nfs Backup + * destination type is NFS. (Value: "NFS") + * @arg @c kGTLROracleDatabase_BackupDestinationDetails_Type_ObjectStore + * Backup destination type is Object Store. (Value: "OBJECT_STORE") + * @arg @c kGTLROracleDatabase_BackupDestinationDetails_Type_RecoveryAppliance + * Backup destination type is Recovery Appliance. (Value: + * "RECOVERY_APPLIANCE") + */ +@property(nonatomic, copy, nullable) NSString *type; + +@end + + +/** + * The request message for Operations.CancelOperation. + */ +@interface GTLROracleDatabase_CancelOperationRequest : GTLRObject +@end + + +/** + * Details of the OCI Cloud Account. + */ +@interface GTLROracleDatabase_CloudAccountDetails : GTLRObject + +/** Output only. URL to create a new account and link. */ +@property(nonatomic, copy, nullable) NSString *accountCreationUri; + +/** Output only. OCI account name. */ +@property(nonatomic, copy, nullable) NSString *cloudAccount; + +/** Output only. OCI account home region. */ +@property(nonatomic, copy, nullable) NSString *cloudAccountHomeRegion; + +/** Output only. URL to link an existing account. */ +@property(nonatomic, copy, nullable) NSString *linkExistingAccountUri; + +@end + + +/** + * Represents CloudExadataInfrastructure resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ + */ +@interface GTLROracleDatabase_CloudExadataInfrastructure : GTLRObject + +/** + * Output only. The date and time that the Exadata Infrastructure was created. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** Optional. User friendly name for this resource. */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** + * Output only. Entitlement ID of the private offer against which this + * infrastructure resource is provisioned. + */ +@property(nonatomic, copy, nullable) NSString *entitlementId; + +/** + * Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. + * Example: us-east4-b-r2. If not specified, the system will pick a zone based + * on availability. + */ +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; + +/** Optional. Labels or tags associated with the resource. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudExadataInfrastructure_Labels *labels; + +/** + * Identifier. The name of the Exadata Infrastructure resource with the format: + * projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Optional. Various properties of the infra. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudExadataInfrastructureProperties *properties; + +@end + + +/** + * Optional. Labels or tags associated with the resource. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLROracleDatabase_CloudExadataInfrastructure_Labels : GTLRObject +@end + + +/** + * Various properties of Exadata Infrastructure. + */ +@interface GTLROracleDatabase_CloudExadataInfrastructureProperties : GTLRObject + +/** + * Output only. The requested number of additional storage servers activated + * for the Exadata Infrastructure. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *activatedStorageCount; + +/** + * Output only. The requested number of additional storage servers for the + * Exadata Infrastructure. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *additionalStorageCount; + +/** + * Output only. The available storage can be allocated to the Exadata + * Infrastructure resource, in gigabytes (GB). + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *availableStorageSizeGb; + +/** + * Optional. The number of compute servers for the Exadata Infrastructure. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *computeCount; + +/** + * Output only. The compute model of the Exadata Infrastructure. + * + * Likely values: + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelEcpu + * Abstract measure of compute resources. ECPUs are based on the number + * of cores elastically allocated from a pool of compute and storage + * servers. (Value: "COMPUTE_MODEL_ECPU") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelOcpu + * Physical measure of compute resources. OCPUs are based on the physical + * core of a processor. (Value: "COMPUTE_MODEL_OCPU") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelUnspecified + * Unspecified compute model. (Value: "COMPUTE_MODEL_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *computeModel; + +/** + * Output only. The number of enabled CPU cores. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *cpuCount; + +/** Optional. The list of customer contacts. */ +@property(nonatomic, strong, nullable) NSArray *customerContacts; + +/** Output only. The database server type of the Exadata Infrastructure. */ +@property(nonatomic, copy, nullable) NSString *databaseServerType; + +/** + * Output only. Size, in terabytes, of the DATA disk group. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeTb; + +/** + * Output only. The local node storage allocated in GBs. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; + +/** + * Output only. The software version of the database servers (dom0) in the + * Exadata Infrastructure. + */ +@property(nonatomic, copy, nullable) NSString *dbServerVersion; + +/** Optional. Maintenance window for repair. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_MaintenanceWindow *maintenanceWindow; + +/** + * Output only. The total number of CPU cores available. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxCpuCount; + +/** + * Output only. The total available DATA disk group size. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxDataStorageTb; + +/** + * Output only. The total local node storage available in GBs. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxDbNodeStorageSizeGb; + +/** + * Output only. The total memory available in GBs. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxMemoryGb; + +/** + * Output only. The memory allocated in GBs. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; + +/** + * Output only. The monthly software version of the database servers (dom0) in + * the Exadata Infrastructure. Example: 20.1.15 + */ +@property(nonatomic, copy, nullable) NSString *monthlyDbServerVersion; + +/** + * Output only. The monthly software version of the storage servers (cells) in + * the Exadata Infrastructure. Example: 20.1.15 + */ +@property(nonatomic, copy, nullable) NSString *monthlyStorageServerVersion; + +/** Output only. The OCID of the next maintenance run. */ +@property(nonatomic, copy, nullable) NSString *nextMaintenanceRunId; + +/** Output only. The time when the next maintenance run will occur. */ +@property(nonatomic, strong, nullable) GTLRDateTime *nextMaintenanceRunTime; + +/** + * Output only. The time when the next security maintenance run will occur. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *nextSecurityMaintenanceRunTime; + +/** + * Output only. OCID of created infra. + * https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + */ +@property(nonatomic, copy, nullable) NSString *ocid; + +/** Output only. Deep link to the OCI console to view this resource. */ +@property(nonatomic, copy, nullable) NSString *ociUrl; + +/** + * Required. The shape of the Exadata Infrastructure. The shape determines the + * amount of CPU, storage, and memory resources allocated to the instance. + */ +@property(nonatomic, copy, nullable) NSString *shape; + +/** + * Output only. The current lifecycle state of the Exadata Infrastructure. + * + * Likely values: + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Available + * The Exadata Infrastructure is available for use. (Value: "AVAILABLE") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Failed + * The Exadata Infrastructure is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_MaintenanceInProgress + * The Exadata Infrastructure is in maintenance. (Value: + * "MAINTENANCE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Provisioning + * The Exadata Infrastructure is being provisioned. (Value: + * "PROVISIONING") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_StateUnspecified + * Default unspecified value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Terminated + * The Exadata Infrastructure is terminated. (Value: "TERMINATED") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Terminating + * The Exadata Infrastructure is being terminated. (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Updating + * The Exadata Infrastructure is being updated. (Value: "UPDATING") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** + * Optional. The number of Cloud Exadata storage servers for the Exadata + * Infrastructure. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *storageCount; + +/** Output only. The storage server type of the Exadata Infrastructure. */ +@property(nonatomic, copy, nullable) NSString *storageServerType; + +/** + * Output only. The software version of the storage servers (cells) in the + * Exadata Infrastructure. + */ +@property(nonatomic, copy, nullable) NSString *storageServerVersion; + +/** + * Optional. The total storage allocated to the Exadata Infrastructure + * resource, in gigabytes (GB). + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalStorageSizeGb; + +@end + + +/** + * Details of the Cloud VM Cluster resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ + */ +@interface GTLROracleDatabase_CloudVmCluster : GTLRObject + +/** + * Optional. The name of the backup OdbSubnet associated with the VM Cluster. + * Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + */ +@property(nonatomic, copy, nullable) NSString *backupOdbSubnet; + +/** Optional. CIDR range of the backup subnet. */ +@property(nonatomic, copy, nullable) NSString *backupSubnetCidr; + +/** Optional. Network settings. CIDR to use for cluster IP allocation. */ +@property(nonatomic, copy, nullable) NSString *cidr; + +/** Output only. The date and time that the VM cluster was created. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** Optional. User friendly name for this resource. */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** + * Required. The name of the Exadata Infrastructure resource on which VM + * cluster resource is created, in the following format: + * projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} + */ +@property(nonatomic, copy, nullable) NSString *exadataInfrastructure; + +/** + * Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This + * will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. + * Example: us-east4-b-r2. + */ +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; + +/** + * Output only. The identity connector details which will allow OCI to securely + * access the resources in the customer project. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_IdentityConnector *identityConnector; + +/** Optional. Labels or tags associated with the VM Cluster. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudVmCluster_Labels *labels; + +/** + * Identifier. The name of the VM Cluster resource with the format: + * projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. The name of the VPC network. Format: + * projects/{project}/global/networks/{network} + */ +@property(nonatomic, copy, nullable) NSString *network; + +/** + * Optional. The name of the OdbNetwork associated with the VM Cluster. Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network} It is + * optional but if specified, this should match the parent ODBNetwork of the + * odb_subnet and backup_odb_subnet. + */ +@property(nonatomic, copy, nullable) NSString *odbNetwork; + +/** + * Optional. The name of the OdbSubnet associated with the VM Cluster for IP + * allocation. Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + */ +@property(nonatomic, copy, nullable) NSString *odbSubnet; + +/** Optional. Various properties of the VM Cluster. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudVmClusterProperties *properties; + +@end + + +/** + * Optional. Labels or tags associated with the VM Cluster. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLROracleDatabase_CloudVmCluster_Labels : GTLRObject +@end + + +/** + * Various properties and settings associated with Exadata VM cluster. + */ +@interface GTLROracleDatabase_CloudVmClusterProperties : GTLRObject + +/** Optional. OCI Cluster name. */ +@property(nonatomic, copy, nullable) NSString *clusterName; + +/** Output only. Compartment ID of cluster. */ +@property(nonatomic, copy, nullable) NSString *compartmentId; + +/** + * Output only. The compute model of the VM Cluster. + * + * Likely values: + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_ComputeModel_ComputeModelEcpu + * Abstract measure of compute resources. ECPUs are based on the number + * of cores elastically allocated from a pool of compute and storage + * servers. (Value: "COMPUTE_MODEL_ECPU") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_ComputeModel_ComputeModelOcpu + * Physical measure of compute resources. OCPUs are based on the physical + * core of a processor. (Value: "COMPUTE_MODEL_OCPU") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_ComputeModel_ComputeModelUnspecified + * Unspecified compute model. (Value: "COMPUTE_MODEL_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *computeModel; + +/** + * Required. Number of enabled CPU cores. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *cpuCoreCount; + +/** + * Optional. The data disk group size to be allocated in TBs. + * + * Uses NSNumber of doubleValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeTb; + +/** + * Optional. Local storage per VM. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; + +/** Optional. OCID of database servers. */ +@property(nonatomic, strong, nullable) NSArray *dbServerOcids; + +/** Optional. Data collection options for diagnostics. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DataCollectionOptions *diagnosticsDataCollectionOptions; + +/** + * Optional. The type of redundancy. + * + * Likely values: + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_DiskRedundancy_DiskRedundancyUnspecified + * Unspecified. (Value: "DISK_REDUNDANCY_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_DiskRedundancy_High + * High - 3 way mirror. (Value: "HIGH") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_DiskRedundancy_Normal + * Normal - 2 way mirror. (Value: "NORMAL") + */ +@property(nonatomic, copy, nullable) NSString *diskRedundancy; + +/** Output only. DNS listener IP. */ +@property(nonatomic, copy, nullable) NSString *dnsListenerIp; + +/** + * Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. + * ex: ocispdelegated.ocisp10jvnet.oraclevcn.com + */ +@property(nonatomic, copy, nullable) NSString *domain; + +/** Optional. Grid Infrastructure Version. */ +@property(nonatomic, copy, nullable) NSString *giVersion; + +/** + * Output only. host name without domain. format: "-" with some suffix. ex: + * sp2-yi0xq where "sp2" is the hostname_prefix. + */ +@property(nonatomic, copy, nullable) NSString *hostname; + +/** Optional. Prefix for VM cluster host names. */ +@property(nonatomic, copy, nullable) NSString *hostnamePrefix; + +/** + * Required. License type of VM Cluster. + * + * Likely values: + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_LicenseType_BringYourOwnLicense + * Bring your own license (Value: "BRING_YOUR_OWN_LICENSE") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_LicenseType_LicenseIncluded + * License included part of offer (Value: "LICENSE_INCLUDED") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_LicenseType_LicenseTypeUnspecified + * Unspecified (Value: "LICENSE_TYPE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *licenseType; + +/** + * Optional. Use local backup. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *localBackupEnabled; + +/** + * Optional. Memory allocated in GBs. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; + +/** + * Optional. Number of database servers. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *nodeCount; + +/** Output only. Oracle Cloud Infrastructure ID of VM Cluster. */ +@property(nonatomic, copy, nullable) NSString *ocid; + +/** Output only. Deep link to the OCI console to view this resource. */ +@property(nonatomic, copy, nullable) NSString *ociUrl; + +/** + * Optional. OCPU count per VM. Minimum is 0.1. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *ocpuCount; + +/** + * Output only. SCAN DNS name. ex: + * sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com + */ +@property(nonatomic, copy, nullable) NSString *scanDns; + +/** Output only. OCID of scan DNS record. */ +@property(nonatomic, copy, nullable) NSString *scanDnsRecordId; + +/** Output only. OCIDs of scan IPs. */ +@property(nonatomic, strong, nullable) NSArray *scanIpIds; + +/** + * Output only. SCAN listener port - TCP + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *scanListenerPortTcp; + +/** + * Output only. SCAN listener port - TLS + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *scanListenerPortTcpSsl; + +/** Output only. Shape of VM Cluster. */ +@property(nonatomic, copy, nullable) NSString *shape; + +/** + * Optional. Use exadata sparse snapshots. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *sparseDiskgroupEnabled; + +/** Optional. SSH public keys to be stored with cluster. */ +@property(nonatomic, strong, nullable) NSArray *sshPublicKeys; + +/** + * Output only. State of the cluster. * * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableState_NotRefreshing - * Not refreshed (Value: "NOT_REFRESHING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableState_RefreshableStateUnspecified - * Default unspecified value. (Value: "REFRESHABLE_STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_RefreshableState_Refreshing - * Refreshing (Value: "REFRESHING") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Available + * Indicates that the resource is in available state. (Value: + * "AVAILABLE") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Failed + * Indicates that the resource is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_MaintenanceInProgress + * Indicates that the resource is in maintenance in progress state. + * (Value: "MAINTENANCE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Provisioning + * Indicates that the resource is in provisioning state. (Value: + * "PROVISIONING") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_StateUnspecified + * Default unspecified value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Terminated + * Indicates that the resource is in terminated state. (Value: + * "TERMINATED") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Terminating + * Indicates that the resource is in terminating state. (Value: + * "TERMINATING") + * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Updating + * Indicates that the resource is in updating state. (Value: "UPDATING") */ -@property(nonatomic, copy, nullable) NSString *refreshableState; +@property(nonatomic, copy, nullable) NSString *state; /** - * Output only. The Data Guard role of the Autonomous Database. + * Output only. The storage allocation for the disk group, in gigabytes (GB). + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *storageSizeGb; + +/** Optional. Operating system version of the image. */ +@property(nonatomic, copy, nullable) NSString *systemVersion; + +/** + * Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_TimeZone *timeZone; + +@end + + +/** + * The CustomerContact reference as defined by Oracle. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact + */ +@interface GTLROracleDatabase_CustomerContact : GTLRObject + +/** + * Required. The email address used by Oracle to send notifications regarding + * databases and infrastructure. + */ +@property(nonatomic, copy, nullable) NSString *email; + +@end + + +/** + * Details of the Database resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ + */ +@interface GTLROracleDatabase_Database : GTLRObject + +/** Required. The password for the default ADMIN user. */ +@property(nonatomic, copy, nullable) NSString *adminPassword; + +/** Optional. The character set for the database. The default is AL32UTF8. */ +@property(nonatomic, copy, nullable) NSString *characterSet; + +/** Output only. The date and time that the Database was created. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** Optional. The database ID of the Database. */ +@property(nonatomic, copy, nullable) NSString *databaseId; + +/** Optional. The name of the DbHome resource associated with the Database. */ +@property(nonatomic, copy, nullable) NSString *dbHomeName; + +/** + * Optional. The database name. The name must begin with an alphabetic + * character and can contain a maximum of eight alphanumeric characters. + * Special characters are not permitted. + */ +@property(nonatomic, copy, nullable) NSString *dbName; + +/** Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up. */ +@property(nonatomic, copy, nullable) NSString *dbUniqueName; + +/** Output only. The GCP Oracle zone where the Database is created. */ +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; + +/** + * Identifier. The name of the Database resource in the following format: + * projects/{project}/locations/{region}/databases/{database} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. The national character set for the database. The default is + * AL16UTF16. + */ +@property(nonatomic, copy, nullable) NSString *ncharacterSet; + +/** + * Output only. HTTPS link to OCI resources exposed to Customer via UI + * Interface. + */ +@property(nonatomic, copy, nullable) NSString *ociUrl; + +/** + * Output only. The Status of Operations Insights for this Database. * * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_BackupCopy - * Backup copy role (Value: "BACKUP_COPY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_DisabledStandby - * Disabled standby role (Value: "DISABLED_STANDBY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_Primary - * Primary role (Value: "PRIMARY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_RoleUnspecified - * Default unspecified value. (Value: "ROLE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_SnapshotStandby - * Snapshot standby role (Value: "SNAPSHOT_STANDBY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_Role_Standby - * Standby role (Value: "STANDBY") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_Disabling Indicates + * that the operations insights are being disabled. (Value: "DISABLING") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_Enabled Indicates + * that the operations insights are enabled. (Value: "ENABLED") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_Enabling Indicates + * that the operations insights are being enabled. (Value: "ENABLING") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_FailedDisabling + * Indicates that the operations insights failed to disable. (Value: + * "FAILED_DISABLING") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_FailedEnabling + * Indicates that the operations insights failed to enable. (Value: + * "FAILED_ENABLING") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_NotEnabled + * Indicates that the operations insights are not enabled. (Value: + * "NOT_ENABLED") + * @arg @c kGTLROracleDatabase_Database_OpsInsightsStatus_OperationsInsightsStatusUnspecified + * Default unspecified value. (Value: + * "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *opsInsightsStatus; + +/** Optional. The properties of the Database. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DatabaseProperties *properties; + +/** Optional. The TDE wallet password for the database. */ +@property(nonatomic, copy, nullable) NSString *tdeWalletPassword; + +@end + + +/** + * Details of the Database character set resource. + */ +@interface GTLROracleDatabase_DatabaseCharacterSet : GTLRObject + +/** + * Output only. The character set name for the Database which is the ID in the + * resource name. + */ +@property(nonatomic, copy, nullable) NSString *characterSet; + +/** + * Output only. The character set type for the Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_CharacterSetTypeUnspecified + * Character set type is not specified. (Value: + * "CHARACTER_SET_TYPE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_Database + * Character set type is set to database. (Value: "DATABASE") + * @arg @c kGTLROracleDatabase_DatabaseCharacterSet_CharacterSetType_National + * Character set type is set to national. (Value: "NATIONAL") + */ +@property(nonatomic, copy, nullable) NSString *characterSetType; + +/** + * Identifier. The name of the Database Character Set resource in the following + * format: + * projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set} + */ +@property(nonatomic, copy, nullable) NSString *name; + +@end + + +/** + * The connection string profile to allow clients to group. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile + */ +@interface GTLROracleDatabase_DatabaseConnectionStringProfile : GTLRObject + +/** + * Output only. The current consumer group being used by the connection. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_ConsumerGroupUnspecified + * Default unspecified value. (Value: "CONSUMER_GROUP_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_High + * High consumer group. (Value: "HIGH") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Low + * Low consumer group. (Value: "LOW") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Medium + * Medium consumer group. (Value: "MEDIUM") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Tp + * TP consumer group. (Value: "TP") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Tpurgent + * TPURGENT consumer group. (Value: "TPURGENT") + */ +@property(nonatomic, copy, nullable) NSString *consumerGroup; + +/** Output only. The display name for the database connection. */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** + * Output only. The host name format being currently used in connection string. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_HostFormat_Fqdn + * FQDN (Value: "FQDN") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_HostFormat_HostFormatUnspecified + * Default unspecified value. (Value: "HOST_FORMAT_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_HostFormat_Ip + * IP (Value: "IP") */ -@property(nonatomic, copy, nullable) NSString *role; +@property(nonatomic, copy, nullable) NSString *hostFormat; /** - * Output only. The list and details of the scheduled operations of the - * Autonomous Database. + * Output only. This field indicates if the connection string is regional and + * is only applicable for cross-region Data Guard. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSArray *scheduledOperationDetails; - -/** Optional. The ID of the Oracle Cloud Infrastructure vault secret. */ -@property(nonatomic, copy, nullable) NSString *secretId; - -/** Output only. The SQL Web Developer URL for the Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *sqlWebDeveloperUrl; +@property(nonatomic, strong, nullable) NSNumber *isRegional; /** - * Output only. The current lifecycle state of the Autonomous Database. + * Output only. The protocol being used by the connection. * * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Available - * Indicates that the Autonomous Database is in available state. (Value: - * "AVAILABLE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_AvailableNeedsAttention - * Indicates that the Autonomous Database is available but needs - * attention state. (Value: "AVAILABLE_NEEDS_ATTENTION") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_BackupInProgress - * Indicates that the Autonomous Database backup is in progress. (Value: - * "BACKUP_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Inaccessible - * Indicates that the Autonomous Database is in inaccessible state. - * (Value: "INACCESSIBLE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_MaintenanceInProgress - * Indicates that the Autonomous Database's maintenance is in progress - * state. (Value: "MAINTENANCE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Provisioning - * Indicates that the Autonomous Database is in provisioning state. - * (Value: "PROVISIONING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Recreating - * Indicates that the Autonomous Database is in recreating state. (Value: - * "RECREATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Restarting - * Indicates that the Autonomous Database is in restarting state. (Value: - * "RESTARTING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_RestoreFailed - * Indicates that the Autonomous Database failed to restore. (Value: - * "RESTORE_FAILED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_RestoreInProgress - * Indicates that the Autonomous Database restore is in progress. (Value: - * "RESTORE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_RoleChangeInProgress - * Indicates that the Autonomous Database's role change is in progress - * state. (Value: "ROLE_CHANGE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_ScaleInProgress - * Indicates that the Autonomous Database scale is in progress. (Value: - * "SCALE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Standby - * Indicates that the Autonomous Database is in standby state. (Value: - * "STANDBY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Starting - * Indicates that the Autonomous Database is in starting state. (Value: - * "STARTING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_StateUnspecified - * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Stopped - * Indicates that the Autonomous Database is in stopped state. (Value: - * "STOPPED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Stopping - * Indicates that the Autonomous Database is in stopping state. (Value: - * "STOPPING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Terminated - * Indicates that the Autonomous Database is in terminated state. (Value: - * "TERMINATED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Terminating - * Indicates that the Autonomous Database is in terminating state. - * (Value: "TERMINATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Unavailable - * Indicates that the Autonomous Database is in unavailable state. - * (Value: "UNAVAILABLE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Updating - * Indicates that the Autonomous Database is in updating state. (Value: - * "UPDATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseProperties_State_Upgrading - * Indicates that the Autonomous Database is in upgrading state. (Value: - * "UPGRADING") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_Protocol_ProtocolUnspecified + * Default unspecified value. (Value: "PROTOCOL_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_Protocol_Tcp + * Tcp (Value: "TCP") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_Protocol_Tcps + * Tcps (Value: "TCPS") */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, copy, nullable) NSString *protocol; /** - * Output only. The list of available regions that can be used to create a - * clone for the Autonomous Database. + * Output only. The current session mode of the connection. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SessionMode_Direct + * Direct (Value: "DIRECT") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SessionMode_Indirect + * Indirect (Value: "INDIRECT") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SessionMode_SessionModeUnspecified + * Default unspecified value. (Value: "SESSION_MODE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSArray *supportedCloneRegions; +@property(nonatomic, copy, nullable) NSString *sessionMode; /** - * Output only. The storage space used by automatic backups of Autonomous - * Database, in gigabytes. + * Output only. The syntax of the connection string. * - * Uses NSNumber of floatValue. + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_Ezconnect + * Ezconnect (Value: "EZCONNECT") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_Ezconnectplus + * Ezconnectplus (Value: "EZCONNECTPLUS") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_Long + * Long (Value: "LONG") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_SyntaxFormatUnspecified + * Default unspecified value. (Value: "SYNTAX_FORMAT_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *totalAutoBackupStorageSizeGbs; +@property(nonatomic, copy, nullable) NSString *syntaxFormat; /** - * Output only. The storage space used by Autonomous Database, in gigabytes. + * Output only. This field indicates the TLS authentication type of the + * connection. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_Mutual + * Mutual (Value: "MUTUAL") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_Server + * Server (Value: "SERVER") + * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_TlsAuthenticationUnspecified + * Default unspecified value. (Value: "TLS_AUTHENTICATION_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *usedDataStorageSizeTbs; +@property(nonatomic, copy, nullable) NSString *tlsAuthentication; -/** Optional. The ID of the Oracle Cloud Infrastructure vault. */ -@property(nonatomic, copy, nullable) NSString *vaultId; +/** Output only. The value of the connection string. */ +@property(nonatomic, copy, nullable) NSString *value; @end /** - * Autonomous Data Guard standby database details. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary + * The configuration of the Database Management service. */ -@interface GTLROracleDatabase_AutonomousDatabaseStandbySummary : GTLRObject +@interface GTLROracleDatabase_DatabaseManagementConfig : GTLRObject /** - * Output only. The date and time the Autonomous Data Guard role was switched - * for the standby Autonomous Database. + * Output only. The status of the Database Management service. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Disabled + * The Database Management service is disabled. (Value: "DISABLED") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Disabling + * The Database Management service is disabling. (Value: "DISABLING") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Enabled + * The Database Management service is enabled. (Value: "ENABLED") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Enabling + * The Database Management service is enabling. (Value: "ENABLING") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedDisabling + * The Database Management service failed to disable. (Value: + * "FAILED_DISABLING") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedEnabling + * The Database Management service failed to enable. (Value: + * "FAILED_ENABLING") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_FailedUpdating + * The Database Management service failed to update. (Value: + * "FAILED_UPDATING") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_ManagementStateUnspecified + * The status is not specified. (Value: "MANAGEMENT_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementState_Updating + * The Database Management service is updating. (Value: "UPDATING") */ -@property(nonatomic, strong, nullable) GTLRDateTime *dataGuardRoleChangedTime; +@property(nonatomic, copy, nullable) NSString *managementState; /** - * Output only. The date and time the Disaster Recovery role was switched for - * the standby Autonomous Database. + * Output only. The Database Management type. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_Advanced + * Advanced Database Management. (Value: "ADVANCED") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_Basic + * Basic Database Management. (Value: "BASIC") + * @arg @c kGTLROracleDatabase_DatabaseManagementConfig_ManagementType_ManagementTypeUnspecified + * The type is not specified. (Value: "MANAGEMENT_TYPE_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) GTLRDateTime *disasterRecoveryRoleChangedTime; +@property(nonatomic, copy, nullable) NSString *managementType; + +@end -/** - * Output only. The amount of time, in seconds, that the data of the standby - * database lags in comparison to the data of the primary database. - */ -@property(nonatomic, strong, nullable) GTLRDuration *lagTimeDuration; /** - * Output only. The additional details about the current lifecycle state of the - * Autonomous Database. + * The properties of a Database. */ -@property(nonatomic, copy, nullable) NSString *lifecycleDetails; +@interface GTLROracleDatabase_DatabaseProperties : GTLRObject + +/** Output only. The Database Management config. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DatabaseManagementConfig *databaseManagementConfig; + +/** Optional. Backup options for the Database. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbBackupConfig *dbBackupConfig; + +/** Required. The Oracle Database version. */ +@property(nonatomic, copy, nullable) NSString *dbVersion; /** - * Output only. The current lifecycle state of the Autonomous Database. + * Output only. State of the Database. * * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Available - * Indicates that the Autonomous Database is in available state. (Value: - * "AVAILABLE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_AvailableNeedsAttention - * Indicates that the Autonomous Database is available but needs - * attention state. (Value: "AVAILABLE_NEEDS_ATTENTION") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_BackupInProgress - * Indicates that the Autonomous Database backup is in progress. (Value: + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Available Indicates + * that the resource is in available state. (Value: "AVAILABLE") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_BackupInProgress + * Indicates that the resource is in backup in progress state. (Value: * "BACKUP_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Inaccessible - * Indicates that the Autonomous Database is in inaccessible state. - * (Value: "INACCESSIBLE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_MaintenanceInProgress - * Indicates that the Autonomous Database's maintenance is in progress - * state. (Value: "MAINTENANCE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Provisioning - * Indicates that the Autonomous Database is in provisioning state. - * (Value: "PROVISIONING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Recreating - * Indicates that the Autonomous Database is in recreating state. (Value: - * "RECREATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Restarting - * Indicates that the Autonomous Database is in restarting state. (Value: - * "RESTARTING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_RestoreFailed - * Indicates that the Autonomous Database failed to restore. (Value: + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Converting Indicates + * that the resource is in converting state. (Value: "CONVERTING") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_DatabaseLifecycleStateUnspecified + * Default unspecified value. (Value: + * "DATABASE_LIFECYCLE_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Failed Indicates that + * the resource is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Provisioning + * Indicates that the resource is in provisioning state. (Value: + * "PROVISIONING") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_RestoreFailed + * Indicates that the resource is in restore failed state. (Value: * "RESTORE_FAILED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_RestoreInProgress - * Indicates that the Autonomous Database restore is in progress. (Value: - * "RESTORE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_RoleChangeInProgress - * Indicates that the Autonomous Database's role change is in progress - * state. (Value: "ROLE_CHANGE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_ScaleInProgress - * Indicates that the Autonomous Database scale is in progress. (Value: - * "SCALE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Standby - * Indicates that the Autonomous Database is in standby state. (Value: - * "STANDBY") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Starting - * Indicates that the Autonomous Database is in starting state. (Value: - * "STARTING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_StateUnspecified - * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Stopped - * Indicates that the Autonomous Database is in stopped state. (Value: - * "STOPPED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Stopping - * Indicates that the Autonomous Database is in stopping state. (Value: - * "STOPPING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Terminated - * Indicates that the Autonomous Database is in terminated state. (Value: - * "TERMINATED") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Terminating - * Indicates that the Autonomous Database is in terminating state. - * (Value: "TERMINATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Unavailable - * Indicates that the Autonomous Database is in unavailable state. - * (Value: "UNAVAILABLE") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Updating - * Indicates that the Autonomous Database is in updating state. (Value: - * "UPDATING") - * @arg @c kGTLROracleDatabase_AutonomousDatabaseStandbySummary_State_Upgrading - * Indicates that the Autonomous Database is in upgrading state. (Value: - * "UPGRADING") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Terminated Indicates + * that the resource is in terminated state. (Value: "TERMINATED") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Terminating Indicates + * that the resource is in terminating state. (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Updating Indicates + * that the resource is in updating state. (Value: "UPDATING") + * @arg @c kGTLROracleDatabase_DatabaseProperties_State_Upgrading Indicates + * that the resource is in upgrading state. (Value: "UPGRADING") + */ +@property(nonatomic, copy, nullable) NSString *state; + +@end + + +/** + * Data collection options for diagnostics. + */ +@interface GTLROracleDatabase_DataCollectionOptions : GTLRObject + +/** + * Optional. Indicates whether diagnostic collection is enabled for the VM + * cluster + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, strong, nullable) NSNumber *diagnosticsEventsEnabled; + +/** + * Optional. Indicates whether health monitoring is enabled for the VM cluster + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *healthMonitoringEnabled; + +/** + * Optional. Indicates whether incident logs and trace collection are enabled + * for the VM cluster + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *incidentLogsEnabled; @end /** - * Details of the Autonomous Database version. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/ + * Data collection options for diagnostics. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions */ -@interface GTLROracleDatabase_AutonomousDbVersion : GTLRObject +@interface GTLROracleDatabase_DataCollectionOptionsCommon : GTLRObject /** - * Output only. The Autonomous Database workload type. + * Optional. Indicates whether to enable data collection for diagnostics. * - * Likely values: - * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Ajd Autonomous - * JSON Database. (Value: "AJD") - * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Apex Autonomous - * Database with the Oracle APEX Application Development workload type. - * (Value: "APEX") - * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_DbWorkloadUnspecified - * Default unspecified value. (Value: "DB_WORKLOAD_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Dw Autonomous - * Data Warehouse database. (Value: "DW") - * @arg @c kGTLROracleDatabase_AutonomousDbVersion_DbWorkload_Oltp Autonomous - * Transaction Processing database. (Value: "OLTP") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *dbWorkload; +@property(nonatomic, strong, nullable) NSNumber *isDiagnosticsEventsEnabled; /** - * Identifier. The name of the Autonomous Database Version resource with the - * format: - * projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version} + * Optional. Indicates whether to enable health monitoring. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Output only. An Oracle Database version for Autonomous Database. */ -@property(nonatomic, copy, nullable) NSString *version; +@property(nonatomic, strong, nullable) NSNumber *isHealthMonitoringEnabled; /** - * Output only. A URL that points to a detailed description of the Autonomous - * Database version. + * Optional. Indicates whether to enable incident logs and trace collection. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *workloadUri; +@property(nonatomic, strong, nullable) NSNumber *isIncidentLogsEnabled; @end /** - * The request message for Operations.CancelOperation. + * Data collection options for DbSystem. */ -@interface GTLROracleDatabase_CancelOperationRequest : GTLRObject -@end - +@interface GTLROracleDatabase_DataCollectionOptionsDbSystem : GTLRObject /** - * Details of the OCI Cloud Account. + * Optional. Indicates whether to enable data collection for diagnostics. + * + * Uses NSNumber of boolValue. */ -@interface GTLROracleDatabase_CloudAccountDetails : GTLRObject - -/** Output only. URL to create a new account and link. */ -@property(nonatomic, copy, nullable) NSString *accountCreationUri; - -/** Output only. OCI account name. */ -@property(nonatomic, copy, nullable) NSString *cloudAccount; +@property(nonatomic, strong, nullable) NSNumber *isDiagnosticsEventsEnabled; -/** Output only. OCI account home region. */ -@property(nonatomic, copy, nullable) NSString *cloudAccountHomeRegion; - -/** Output only. URL to link an existing account. */ -@property(nonatomic, copy, nullable) NSString *linkExistingAccountUri; +/** + * Optional. Indicates whether to enable incident logs and trace collection. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isIncidentLogsEnabled; @end /** - * Represents CloudExadataInfrastructure resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ + * Backup Options for the Database. */ -@interface GTLROracleDatabase_CloudExadataInfrastructure : GTLRObject +@interface GTLROracleDatabase_DbBackupConfig : GTLRObject /** - * Output only. The date and time that the Exadata Infrastructure was created. + * Optional. If set to true, enables automatic backups on the database. + * + * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *createTime; +@property(nonatomic, strong, nullable) NSNumber *autoBackupEnabled; -/** Optional. User friendly name for this resource. */ -@property(nonatomic, copy, nullable) NSString *displayName; +/** + * Optional. The day of the week on which the full backup should be performed + * on the database. If no value is provided, it will default to Sunday. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_DayOfWeekUnspecified + * The day of the week is unspecified. (Value: "DAY_OF_WEEK_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Friday Friday + * (Value: "FRIDAY") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Monday Monday + * (Value: "MONDAY") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Saturday + * Saturday (Value: "SATURDAY") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Sunday Sunday + * (Value: "SUNDAY") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Thursday + * Thursday (Value: "THURSDAY") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Tuesday + * Tuesday (Value: "TUESDAY") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupDay_Wednesday + * Wednesday (Value: "WEDNESDAY") + */ +@property(nonatomic, copy, nullable) NSString *autoFullBackupDay; /** - * Output only. Entitlement ID of the private offer against which this - * infrastructure resource is provisioned. + * Optional. The window in which the full backup should be performed on the + * database. If no value is provided, the default is anytime. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_BackupWindowUnspecified + * Default unspecified value. (Value: "BACKUP_WINDOW_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotEight + * 2:00 PM - 4:00 PM (Value: "SLOT_EIGHT") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotEleven + * 8:00 PM - 10:00 PM (Value: "SLOT_ELEVEN") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotFive + * 8:00 AM - 10:00 AM (Value: "SLOT_FIVE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotFour + * 6:00 AM - 8:00 AM (Value: "SLOT_FOUR") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotNine + * 4:00 PM - 6:00 PM (Value: "SLOT_NINE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotOne + * 12:00 AM - 2:00 AM (Value: "SLOT_ONE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotSeven + * 12:00 PM - 2:00 PM (Value: "SLOT_SEVEN") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotSix + * 10:00 AM - 12:00 PM (Value: "SLOT_SIX") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTen + * 6:00 PM - 8:00 PM (Value: "SLOT_TEN") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotThree + * 4:00 AM - 6:00 AM (Value: "SLOT_THREE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTwelve + * 10:00 PM - 12:00 AM (Value: "SLOT_TWELVE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoFullBackupWindow_SlotTwo + * 2:00 AM - 4:00 AM (Value: "SLOT_TWO") + */ +@property(nonatomic, copy, nullable) NSString *autoFullBackupWindow; + +/** + * Optional. The window in which the incremental backup should be performed on + * the database. If no value is provided, the default is anytime except the + * auto full backup day. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_BackupWindowUnspecified + * Default unspecified value. (Value: "BACKUP_WINDOW_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotEight + * 2:00 PM - 4:00 PM (Value: "SLOT_EIGHT") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotEleven + * 8:00 PM - 10:00 PM (Value: "SLOT_ELEVEN") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotFive + * 8:00 AM - 10:00 AM (Value: "SLOT_FIVE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotFour + * 6:00 AM - 8:00 AM (Value: "SLOT_FOUR") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotNine + * 4:00 PM - 6:00 PM (Value: "SLOT_NINE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotOne + * 12:00 AM - 2:00 AM (Value: "SLOT_ONE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotSeven + * 12:00 PM - 2:00 PM (Value: "SLOT_SEVEN") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotSix + * 10:00 AM - 12:00 PM (Value: "SLOT_SIX") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTen + * 6:00 PM - 8:00 PM (Value: "SLOT_TEN") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotThree + * 4:00 AM - 6:00 AM (Value: "SLOT_THREE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTwelve + * 10:00 PM - 12:00 AM (Value: "SLOT_TWELVE") + * @arg @c kGTLROracleDatabase_DbBackupConfig_AutoIncrementalBackupWindow_SlotTwo + * 2:00 AM - 4:00 AM (Value: "SLOT_TWO") + */ +@property(nonatomic, copy, nullable) NSString *autoIncrementalBackupWindow; + +/** + * Optional. This defines when the backups will be deleted after Database + * termination. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_BackupDeletionPolicyUnspecified + * Default unspecified value. (Value: + * "BACKUP_DELETION_POLICY_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_DeleteAfterRetentionPeriod + * Keeps the backups as per the policy defined for database backups. + * (Value: "DELETE_AFTER_RETENTION_PERIOD") + * @arg @c kGTLROracleDatabase_DbBackupConfig_BackupDeletionPolicy_DeleteImmediately + * Keeps the backup for predefined time i.e. 72 hours and then delete + * permanently. (Value: "DELETE_IMMEDIATELY") */ -@property(nonatomic, copy, nullable) NSString *entitlementId; +@property(nonatomic, copy, nullable) NSString *backupDeletionPolicy; + +/** Optional. Details of the database backup destinations. */ +@property(nonatomic, strong, nullable) NSArray *backupDestinationDetails; /** - * Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. - * Example: us-east4-b-r2. If not specified, the system will pick a zone based - * on availability. + * Optional. The number of days an automatic backup is retained before being + * automatically deleted. This value determines the earliest point in time to + * which a database can be restored. Min: 1, Max: 60. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *gcpOracleZone; +@property(nonatomic, strong, nullable) NSNumber *retentionPeriodDays; + +@end -/** Optional. Labels or tags associated with the resource. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudExadataInfrastructure_Labels *labels; /** - * Identifier. The name of the Exadata Infrastructure resource with the format: - * projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} + * Details of the Database Home resource. */ -@property(nonatomic, copy, nullable) NSString *name; +@interface GTLROracleDatabase_DbHome : GTLRObject -/** Optional. Various properties of the infra. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudExadataInfrastructureProperties *properties; +/** Required. The Database resource. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_Database *database; -@end +/** + * Required. A valid Oracle Database version. For a list of supported versions, + * use the ListDbVersions operation. + */ +@property(nonatomic, copy, nullable) NSString *dbVersion; +/** + * Optional. The display name for the Database Home. The name does not have to + * be unique within your project. + */ +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Optional. Labels or tags associated with the resource. + * Optional. Whether unified auditing is enabled for the Database Home. * - * @note This class is documented as having more properties of NSString. Use @c - * -additionalJSONKeys and @c -additionalPropertyForName: to get the list - * of properties and then fetch them; or @c -additionalProperties to - * fetch them all at once. + * Uses NSNumber of boolValue. */ -@interface GTLROracleDatabase_CloudExadataInfrastructure_Labels : GTLRObject +@property(nonatomic, strong, nullable) NSNumber *isUnifiedAuditingEnabled; + @end /** - * Various properties of Exadata Infrastructure. + * Details of the database node resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/ */ -@interface GTLROracleDatabase_CloudExadataInfrastructureProperties : GTLRObject +@interface GTLROracleDatabase_DbNode : GTLRObject /** - * Output only. The requested number of additional storage servers activated - * for the Exadata Infrastructure. - * - * Uses NSNumber of intValue. + * Identifier. The name of the database node resource in the following format: + * projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node} */ -@property(nonatomic, strong, nullable) NSNumber *activatedStorageCount; +@property(nonatomic, copy, nullable) NSString *name; + +/** Optional. Various properties of the database node. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbNodeProperties *properties; + +@end + /** - * Output only. The requested number of additional storage servers for the - * Exadata Infrastructure. + * Various properties and settings associated with Db node. + */ +@interface GTLROracleDatabase_DbNodeProperties : GTLRObject + +/** Output only. The date and time that the database node was created. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Optional. Local storage per database node. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *additionalStorageCount; +@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; + +/** Optional. Database server OCID. */ +@property(nonatomic, copy, nullable) NSString *dbServerOcid; + +/** Optional. DNS */ +@property(nonatomic, copy, nullable) NSString *hostname; /** - * Output only. The available storage can be allocated to the Exadata - * Infrastructure resource, in gigabytes (GB). + * Memory allocated in GBs. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *availableStorageSizeGb; +@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; + +/** Output only. OCID of database node. */ +@property(nonatomic, copy, nullable) NSString *ocid; /** - * Optional. The number of compute servers for the Exadata Infrastructure. + * Optional. OCPU count per database node. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *computeCount; +@property(nonatomic, strong, nullable) NSNumber *ocpuCount; /** - * Output only. The compute model of the Exadata Infrastructure. + * Output only. State of the database node. * * Likely values: - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelEcpu - * Abstract measure of compute resources. ECPUs are based on the number - * of cores elastically allocated from a pool of compute and storage - * servers. (Value: "COMPUTE_MODEL_ECPU") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelOcpu - * Physical measure of compute resources. OCPUs are based on the physical - * core of a processor. (Value: "COMPUTE_MODEL_OCPU") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_ComputeModel_ComputeModelUnspecified - * Unspecified compute model. (Value: "COMPUTE_MODEL_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Available Indicates + * that the resource is in available state. (Value: "AVAILABLE") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Failed Indicates that + * the resource is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Provisioning Indicates + * that the resource is in provisioning state. (Value: "PROVISIONING") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Starting Indicates that + * the resource is in starting state. (Value: "STARTING") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_StateUnspecified + * Default unspecified value. (Value: "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Stopped Indicates that + * the resource is in stopped state. (Value: "STOPPED") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Stopping Indicates that + * the resource is in stopping state. (Value: "STOPPING") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Terminated Indicates + * that the resource is in terminated state. (Value: "TERMINATED") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Terminating Indicates + * that the resource is in terminating state. (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Updating Indicates that + * the resource is in updating state. (Value: "UPDATING") */ -@property(nonatomic, copy, nullable) NSString *computeModel; +@property(nonatomic, copy, nullable) NSString *state; /** - * Output only. The number of enabled CPU cores. + * Total CPU core count of the database node. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *cpuCount; +@property(nonatomic, strong, nullable) NSNumber *totalCpuCoreCount; -/** Optional. The list of customer contacts. */ -@property(nonatomic, strong, nullable) NSArray *customerContacts; +@end -/** Output only. The database server type of the Exadata Infrastructure. */ -@property(nonatomic, copy, nullable) NSString *databaseServerType; /** - * Output only. Size, in terabytes, of the DATA disk group. - * - * Uses NSNumber of doubleValue. + * Details of the database server resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/ */ -@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeTb; +@interface GTLROracleDatabase_DbServer : GTLRObject -/** - * Output only. The local node storage allocated in GBs. - * - * Uses NSNumber of intValue. - */ -@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; +/** Optional. User friendly name for this resource. */ +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Output only. The software version of the database servers (dom0) in the - * Exadata Infrastructure. + * Identifier. The name of the database server resource with the format: + * projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} */ -@property(nonatomic, copy, nullable) NSString *dbServerVersion; +@property(nonatomic, copy, nullable) NSString *name; -/** Optional. Maintenance window for repair. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_MaintenanceWindow *maintenanceWindow; +/** Optional. Various properties of the database server. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbServerProperties *properties; + +@end + + +/** + * Various properties and settings associated with Exadata database server. + */ +@interface GTLROracleDatabase_DbServerProperties : GTLRObject /** - * Output only. The total number of CPU cores available. - * - * Uses NSNumber of intValue. + * Output only. OCID of database nodes associated with the database server. */ -@property(nonatomic, strong, nullable) NSNumber *maxCpuCount; +@property(nonatomic, strong, nullable) NSArray *dbNodeIds; /** - * Output only. The total available DATA disk group size. + * Optional. Local storage per VM. * - * Uses NSNumber of doubleValue. + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *maxDataStorageTb; +@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; /** - * Output only. The total local node storage available in GBs. + * Optional. Maximum local storage per VM. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *maxDbNodeStorageSizeGb; /** - * Output only. The total memory available in GBs. + * Optional. Maximum memory allocated in GBs. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *maxMemoryGb; +@property(nonatomic, strong, nullable) NSNumber *maxMemorySizeGb; /** - * Output only. The memory allocated in GBs. + * Optional. Maximum OCPU count per database. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; - -/** - * Output only. The monthly software version of the database servers (dom0) in - * the Exadata Infrastructure. Example: 20.1.15 - */ -@property(nonatomic, copy, nullable) NSString *monthlyDbServerVersion; - -/** - * Output only. The monthly software version of the storage servers (cells) in - * the Exadata Infrastructure. Example: 20.1.15 - */ -@property(nonatomic, copy, nullable) NSString *monthlyStorageServerVersion; - -/** Output only. The OCID of the next maintenance run. */ -@property(nonatomic, copy, nullable) NSString *nextMaintenanceRunId; - -/** Output only. The time when the next maintenance run will occur. */ -@property(nonatomic, strong, nullable) GTLRDateTime *nextMaintenanceRunTime; +@property(nonatomic, strong, nullable) NSNumber *maxOcpuCount; /** - * Output only. The time when the next security maintenance run will occur. + * Optional. Memory allocated in GBs. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) GTLRDateTime *nextSecurityMaintenanceRunTime; +@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; -/** - * Output only. OCID of created infra. - * https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle - */ +/** Output only. OCID of database server. */ @property(nonatomic, copy, nullable) NSString *ocid; -/** Output only. Deep link to the OCI console to view this resource. */ -@property(nonatomic, copy, nullable) NSString *ociUrl; - /** - * Required. The shape of the Exadata Infrastructure. The shape determines the - * amount of CPU, storage, and memory resources allocated to the instance. + * Optional. OCPU count per database. + * + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *shape; +@property(nonatomic, strong, nullable) NSNumber *ocpuCount; /** - * Output only. The current lifecycle state of the Exadata Infrastructure. + * Output only. State of the database server. * * Likely values: - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Available - * The Exadata Infrastructure is available for use. (Value: "AVAILABLE") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Failed - * The Exadata Infrastructure is in failed state. (Value: "FAILED") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_MaintenanceInProgress - * The Exadata Infrastructure is in maintenance. (Value: - * "MAINTENANCE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Provisioning - * The Exadata Infrastructure is being provisioned. (Value: - * "PROVISIONING") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_StateUnspecified + * @arg @c kGTLROracleDatabase_DbServerProperties_State_Available Indicates + * that the resource is in available state. (Value: "AVAILABLE") + * @arg @c kGTLROracleDatabase_DbServerProperties_State_Creating Indicates + * that the resource is in creating state. (Value: "CREATING") + * @arg @c kGTLROracleDatabase_DbServerProperties_State_Deleted Indicates + * that the resource is in deleted state. (Value: "DELETED") + * @arg @c kGTLROracleDatabase_DbServerProperties_State_Deleting Indicates + * that the resource is in deleting state. (Value: "DELETING") + * @arg @c kGTLROracleDatabase_DbServerProperties_State_StateUnspecified * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Terminated - * The Exadata Infrastructure is terminated. (Value: "TERMINATED") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Terminating - * The Exadata Infrastructure is being terminated. (Value: "TERMINATING") - * @arg @c kGTLROracleDatabase_CloudExadataInfrastructureProperties_State_Updating - * The Exadata Infrastructure is being updated. (Value: "UPDATING") + * @arg @c kGTLROracleDatabase_DbServerProperties_State_Unavailable Indicates + * that the resource is in unavailable state. (Value: "UNAVAILABLE") */ @property(nonatomic, copy, nullable) NSString *state; /** - * Optional. The number of Cloud Exadata storage servers for the Exadata - * Infrastructure. - * - * Uses NSNumber of intValue. - */ -@property(nonatomic, strong, nullable) NSNumber *storageCount; - -/** Output only. The storage server type of the Exadata Infrastructure. */ -@property(nonatomic, copy, nullable) NSString *storageServerType; - -/** - * Output only. The software version of the storage servers (cells) in the - * Exadata Infrastructure. - */ -@property(nonatomic, copy, nullable) NSString *storageServerVersion; - -/** - * Optional. The total storage allocated to the Exadata Infrastructure - * resource, in gigabytes (GB). + * Optional. Vm count per database. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *totalStorageSizeGb; +@property(nonatomic, strong, nullable) NSNumber *vmCount; @end /** - * Details of the Cloud VM Cluster resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ - */ -@interface GTLROracleDatabase_CloudVmCluster : GTLRObject - -/** - * Optional. The name of the backup OdbSubnet associated with the VM Cluster. - * Format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + * Details of the DbSystem (BaseDB) resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/ */ -@property(nonatomic, copy, nullable) NSString *backupOdbSubnet; - -/** Optional. CIDR range of the backup subnet. */ -@property(nonatomic, copy, nullable) NSString *backupSubnetCidr; +@interface GTLROracleDatabase_DbSystem : GTLRObject -/** Optional. Network settings. CIDR to use for cluster IP allocation. */ -@property(nonatomic, copy, nullable) NSString *cidr; - -/** Output only. The date and time that the VM cluster was created. */ +/** Output only. The date and time that the DbSystem was created. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; -/** Optional. User friendly name for this resource. */ -@property(nonatomic, copy, nullable) NSString *displayName; - /** - * Required. The name of the Exadata Infrastructure resource on which VM - * cluster resource is created, in the following format: - * projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} + * Required. The display name for the System db. The name does not have to be + * unique within your project. */ -@property(nonatomic, copy, nullable) NSString *exadataInfrastructure; +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This - * will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. - * Example: us-east4-b-r2. + * Output only. The ID of the subscription entitlement associated with the + * DbSystem */ -@property(nonatomic, copy, nullable) NSString *gcpOracleZone; +@property(nonatomic, copy, nullable) NSString *entitlementId; /** - * Output only. The identity connector details which will allow OCI to securely - * access the resources in the customer project. + * Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: + * us-east4-b-r2. If not specified, the system will pick a zone based on + * availability. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_IdentityConnector *identityConnector; +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; -/** Optional. Labels or tags associated with the VM Cluster. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudVmCluster_Labels *labels; +/** Optional. The labels or tags associated with the DbSystem. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbSystem_Labels *labels; /** - * Identifier. The name of the VM Cluster resource with the format: - * projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} + * Identifier. The name of the DbSystem resource in the following format: + * projects/{project}/locations/{region}/dbSystems/{db_system} */ @property(nonatomic, copy, nullable) NSString *name; /** - * Optional. The name of the VPC network. Format: - * projects/{project}/global/networks/{network} + * Output only. HTTPS link to OCI resources exposed to Customer via UI + * Interface. */ -@property(nonatomic, copy, nullable) NSString *network; +@property(nonatomic, copy, nullable) NSString *ociUrl; /** - * Optional. The name of the OdbNetwork associated with the VM Cluster. Format: + * Optional. The name of the OdbNetwork associated with the DbSystem. Format: * projects/{project}/locations/{location}/odbNetworks/{odb_network} It is * optional but if specified, this should match the parent ODBNetwork of the - * odb_subnet and backup_odb_subnet. + * OdbSubnet. */ @property(nonatomic, copy, nullable) NSString *odbNetwork; /** - * Optional. The name of the OdbSubnet associated with the VM Cluster for IP + * Required. The name of the OdbSubnet associated with the DbSystem for IP * allocation. Format: * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} */ @property(nonatomic, copy, nullable) NSString *odbSubnet; -/** Optional. Various properties of the VM Cluster. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudVmClusterProperties *properties; +/** Optional. The properties of the DbSystem. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbSystemProperties *properties; @end /** - * Optional. Labels or tags associated with the VM Cluster. + * Optional. The labels or tags associated with the DbSystem. * * @note This class is documented as having more properties of NSString. Use @c * -additionalJSONKeys and @c -additionalPropertyForName: to get the list * of properties and then fetch them; or @c -additionalProperties to * fetch them all at once. */ -@interface GTLROracleDatabase_CloudVmCluster_Labels : GTLRObject +@interface GTLROracleDatabase_DbSystem_Labels : GTLRObject @end /** - * Various properties and settings associated with Exadata VM cluster. + * Summary of the DbSystem initial storage size. */ -@interface GTLROracleDatabase_CloudVmClusterProperties : GTLRObject +@interface GTLROracleDatabase_DbSystemInitialStorageSize : GTLRObject -/** Optional. OCI Cluster name. */ -@property(nonatomic, copy, nullable) NSString *clusterName; +/** Output only. The name of the resource. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Output only. The properties of the DbSystem initial storage size summary. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbSystemInitialStorageSizeProperties *properties; + +@end -/** Output only. Compartment ID of cluster. */ -@property(nonatomic, copy, nullable) NSString *compartmentId; /** - * Output only. The compute model of the VM Cluster. - * - * Likely values: - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_ComputeModel_ComputeModelEcpu - * Abstract measure of compute resources. ECPUs are based on the number - * of cores elastically allocated from a pool of compute and storage - * servers. (Value: "COMPUTE_MODEL_ECPU") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_ComputeModel_ComputeModelOcpu - * Physical measure of compute resources. OCPUs are based on the physical - * core of a processor. (Value: "COMPUTE_MODEL_OCPU") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_ComputeModel_ComputeModelUnspecified - * Unspecified compute model. (Value: "COMPUTE_MODEL_UNSPECIFIED") + * The properties of a DbSystem initial storage size summary. */ -@property(nonatomic, copy, nullable) NSString *computeModel; +@interface GTLROracleDatabase_DbSystemInitialStorageSizeProperties : GTLRObject /** - * Required. Number of enabled CPU cores. - * - * Uses NSNumber of intValue. + * Output only. List of storage disk details available for launches from + * backup. */ -@property(nonatomic, strong, nullable) NSNumber *cpuCoreCount; +@property(nonatomic, strong, nullable) NSArray *launchFromBackupStorageSizeDetails; /** - * Optional. The data disk group size to be allocated in TBs. + * Output only. VM shape platform type * - * Uses NSNumber of doubleValue. + * Likely values: + * @arg @c kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_ShapeType_ShapeTypeUnspecified + * Unspecified shape type. (Value: "SHAPE_TYPE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_ShapeType_StandardX86 + * Standard X86. (Value: "STANDARD_X86") */ -@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeTb; +@property(nonatomic, copy, nullable) NSString *shapeType; /** - * Optional. Local storage per VM. + * Output only. The storage option used in DB system. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_Asm + * Automatic Storage Management. (Value: "ASM") + * @arg @c kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_Lvm + * Logical Volume Management. (Value: "LVM") + * @arg @c kGTLROracleDatabase_DbSystemInitialStorageSizeProperties_StorageManagement_StorageManagementUnspecified + * Unspecified storage management. (Value: + * "STORAGE_MANAGEMENT_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; +@property(nonatomic, copy, nullable) NSString *storageManagement; -/** Optional. OCID of database servers. */ -@property(nonatomic, strong, nullable) NSArray *dbServerOcids; +/** Output only. List of storage disk details. */ +@property(nonatomic, strong, nullable) NSArray *storageSizeDetails; + +@end -/** Optional. Data collection options for diagnostics. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_DataCollectionOptions *diagnosticsDataCollectionOptions; /** - * Optional. The type of redundancy. + * Details of the DbSystem Options. + */ +@interface GTLROracleDatabase_DbSystemOptions : GTLRObject + +/** + * Optional. The storage option used in DB system. * * Likely values: - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_DiskRedundancy_DiskRedundancyUnspecified - * Unspecified. (Value: "DISK_REDUNDANCY_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_DiskRedundancy_High - * High - 3 way mirror. (Value: "HIGH") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_DiskRedundancy_Normal - * Normal - 2 way mirror. (Value: "NORMAL") + * @arg @c kGTLROracleDatabase_DbSystemOptions_StorageManagement_Asm + * Automatic storage management. (Value: "ASM") + * @arg @c kGTLROracleDatabase_DbSystemOptions_StorageManagement_Lvm Logical + * Volume management. (Value: "LVM") + * @arg @c kGTLROracleDatabase_DbSystemOptions_StorageManagement_StorageManagementUnspecified + * The storage management is unspecified. (Value: + * "STORAGE_MANAGEMENT_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *diskRedundancy; +@property(nonatomic, copy, nullable) NSString *storageManagement; + +@end -/** Output only. DNS listener IP. */ -@property(nonatomic, copy, nullable) NSString *dnsListenerIp; /** - * Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. - * ex: ocispdelegated.ocisp10jvnet.oraclevcn.com + * The properties of a DbSystem. */ -@property(nonatomic, copy, nullable) NSString *domain; +@interface GTLROracleDatabase_DbSystemProperties : GTLRObject -/** Optional. Grid Infrastructure Version. */ -@property(nonatomic, copy, nullable) NSString *giVersion; +/** + * Required. The number of CPU cores to enable for the DbSystem. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *computeCount; /** - * Output only. host name without domain. format: "-" with some suffix. ex: - * sp2-yi0xq where "sp2" is the hostname_prefix. + * Optional. The compute model of the DbSystem. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DbSystemProperties_ComputeModel_ComputeModelUnspecified + * The compute model is unspecified. (Value: "COMPUTE_MODEL_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_ComputeModel_Ecpu The + * compute model is virtual. (Value: "ECPU") + * @arg @c kGTLROracleDatabase_DbSystemProperties_ComputeModel_Ocpu The + * compute model is physical. (Value: "OCPU") + */ +@property(nonatomic, copy, nullable) NSString *computeModel; + +/** + * Required. The database edition of the DbSystem. + * + * Likely values: + * @arg @c kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_DbSystemDatabaseEditionUnspecified + * The database edition is unspecified. (Value: + * "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_EnterpriseEdition + * The database edition is Enterprise. (Value: "ENTERPRISE_EDITION") + * @arg @c kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_EnterpriseEditionHighPerformance + * The database edition is Enterprise Edition. (Value: + * "ENTERPRISE_EDITION_HIGH_PERFORMANCE") + * @arg @c kGTLROracleDatabase_DbSystemProperties_DatabaseEdition_StandardEdition + * The database edition is Standard. (Value: "STANDARD_EDITION") + */ +@property(nonatomic, copy, nullable) NSString *databaseEdition; + +/** Optional. Data collection options for diagnostics. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DataCollectionOptionsDbSystem *dataCollectionOptions; + +/** + * Optional. The data storage size in GB that is currently available to + * DbSystems. + * + * Uses NSNumber of intValue. */ +@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeGb; + +/** Optional. Details for creating a Database Home. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbHome *dbHome; + +/** Optional. The options for the DbSystem. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbSystemOptions *dbSystemOptions; + +/** Optional. The host domain name of the DbSystem. */ +@property(nonatomic, copy, nullable) NSString *domain; + +/** Output only. The hostname of the DbSystem. */ @property(nonatomic, copy, nullable) NSString *hostname; -/** Optional. Prefix for VM cluster host names. */ +/** Optional. Prefix for DB System host names. */ @property(nonatomic, copy, nullable) NSString *hostnamePrefix; /** - * Required. License type of VM Cluster. + * Required. The initial data storage size in GB. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *initialDataStorageSizeGb; + +/** + * Required. The license model of the DbSystem. * * Likely values: - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_LicenseType_BringYourOwnLicense - * Bring your own license (Value: "BRING_YOUR_OWN_LICENSE") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_LicenseType_LicenseIncluded - * License included part of offer (Value: "LICENSE_INCLUDED") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_LicenseType_LicenseTypeUnspecified - * Unspecified (Value: "LICENSE_TYPE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LicenseModel_BringYourOwnLicense + * The license model is bring your own license. (Value: + * "BRING_YOUR_OWN_LICENSE") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LicenseModel_LicenseIncluded + * The license model is included. (Value: "LICENSE_INCLUDED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LicenseModel_LicenseModelUnspecified + * The license model is unspecified. (Value: "LICENSE_MODEL_UNSPECIFIED") */ -@property(nonatomic, copy, nullable) NSString *licenseType; +@property(nonatomic, copy, nullable) NSString *licenseModel; /** - * Optional. Use local backup. + * Output only. State of the DbSystem. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Available + * Indicates that the resource is in available state. (Value: + * "AVAILABLE") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_DbSystemLifecycleStateUnspecified + * Default unspecified value. (Value: + * "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Failed + * Indicates that the resource is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_MaintenanceInProgress + * Indicates that the resource is in maintenance in progress state. + * (Value: "MAINTENANCE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Migrated + * Indicates that the resource has been migrated. (Value: "MIGRATED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_NeedsAttention + * Indicates that the resource needs attention. (Value: + * "NEEDS_ATTENTION") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Provisioning + * Indicates that the resource is in provisioning state. (Value: + * "PROVISIONING") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Terminated + * Indicates that the resource is in terminated state. (Value: + * "TERMINATED") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Terminating + * Indicates that the resource is in terminating state. (Value: + * "TERMINATING") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Updating + * Indicates that the resource is in updating state. (Value: "UPDATING") + * @arg @c kGTLROracleDatabase_DbSystemProperties_LifecycleState_Upgrading + * Indicates that the resource is upgrading. (Value: "UPGRADING") */ -@property(nonatomic, strong, nullable) NSNumber *localBackupEnabled; +@property(nonatomic, copy, nullable) NSString *lifecycleState; /** - * Optional. Memory allocated in GBs. + * Optional. The memory size in GB. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *memorySizeGb; /** - * Optional. Number of database servers. + * Optional. The number of nodes in the DbSystem. * * Uses NSNumber of intValue. */ @property(nonatomic, strong, nullable) NSNumber *nodeCount; -/** Output only. Oracle Cloud Infrastructure ID of VM Cluster. */ +/** Output only. OCID of the DbSystem. */ @property(nonatomic, copy, nullable) NSString *ocid; -/** Output only. Deep link to the OCI console to view this resource. */ -@property(nonatomic, copy, nullable) NSString *ociUrl; +/** Optional. The private IP address of the DbSystem. */ +@property(nonatomic, copy, nullable) NSString *privateIp; /** - * Optional. OCPU count per VM. Minimum is 0.1. + * Optional. The reco/redo storage size in GB. * - * Uses NSNumber of floatValue. + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *ocpuCount; +@property(nonatomic, strong, nullable) NSNumber *recoStorageSizeGb; + +/** Required. Shape of DB System. */ +@property(nonatomic, copy, nullable) NSString *shape; + +/** Required. SSH public keys to be stored with the DbSystem. */ +@property(nonatomic, strong, nullable) NSArray *sshPublicKeys; + +/** Optional. Time zone of the DbSystem. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_TimeZone *timeZone; + +@end + /** - * Output only. SCAN DNS name. ex: - * sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com + * Details of the Database System Shapes resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ */ -@property(nonatomic, copy, nullable) NSString *scanDns; +@interface GTLROracleDatabase_DbSystemShape : GTLRObject -/** Output only. OCID of scan DNS record. */ -@property(nonatomic, copy, nullable) NSString *scanDnsRecordId; +/** + * Optional. Number of cores per node. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *availableCoreCountPerNode; -/** Output only. OCIDs of scan IPs. */ -@property(nonatomic, strong, nullable) NSArray *scanIpIds; +/** + * Optional. Storage per storage server in terabytes. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *availableDataStorageTb; /** - * Output only. SCAN listener port - TCP + * Optional. Memory per database server node in gigabytes. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *scanListenerPortTcp; +@property(nonatomic, strong, nullable) NSNumber *availableMemoryPerNodeGb; /** - * Output only. SCAN listener port - TLS + * Optional. Maximum number of database servers. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *scanListenerPortTcpSsl; +@property(nonatomic, strong, nullable) NSNumber *maxNodeCount; -/** Output only. Shape of VM Cluster. */ -@property(nonatomic, copy, nullable) NSString *shape; +/** + * Optional. Maximum number of storage servers. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxStorageCount; /** - * Optional. Use exadata sparse snapshots. + * Optional. Minimum core count per node. * - * Uses NSNumber of boolValue. + * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *sparseDiskgroupEnabled; +@property(nonatomic, strong, nullable) NSNumber *minCoreCountPerNode; -/** Optional. SSH public keys to be stored with cluster. */ -@property(nonatomic, strong, nullable) NSArray *sshPublicKeys; +/** + * Optional. Minimum node storage per database server in gigabytes. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *minDbNodeStoragePerNodeGb; /** - * Output only. State of the cluster. + * Optional. Minimum memory per node in gigabytes. * - * Likely values: - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Available - * Indicates that the resource is in available state. (Value: - * "AVAILABLE") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Failed - * Indicates that the resource is in failed state. (Value: "FAILED") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_MaintenanceInProgress - * Indicates that the resource is in maintenance in progress state. - * (Value: "MAINTENANCE_IN_PROGRESS") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Provisioning - * Indicates that the resource is in provisioning state. (Value: - * "PROVISIONING") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_StateUnspecified - * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Terminated - * Indicates that the resource is in terminated state. (Value: - * "TERMINATED") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Terminating - * Indicates that the resource is in terminating state. (Value: - * "TERMINATING") - * @arg @c kGTLROracleDatabase_CloudVmClusterProperties_State_Updating - * Indicates that the resource is in updating state. (Value: "UPDATING") + * Uses NSNumber of intValue. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, strong, nullable) NSNumber *minMemoryPerNodeGb; /** - * Output only. The storage allocation for the disk group, in gigabytes (GB). + * Optional. Minimum number of database servers. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *storageSizeGb; +@property(nonatomic, strong, nullable) NSNumber *minNodeCount; -/** Optional. Operating system version of the image. */ -@property(nonatomic, copy, nullable) NSString *systemVersion; +/** + * Optional. Minimum number of storage servers. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *minStorageCount; /** - * Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified. + * Identifier. The name of the Database System Shape resource with the format: + * projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape} */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_TimeZone *timeZone; +@property(nonatomic, copy, nullable) NSString *name; + +/** Optional. shape */ +@property(nonatomic, copy, nullable) NSString *shape; @end /** - * The CustomerContact reference as defined by Oracle. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact + * A valid Oracle Database version. */ -@interface GTLROracleDatabase_CustomerContact : GTLRObject +@interface GTLROracleDatabase_DbVersion : GTLRObject /** - * Required. The email address used by Oracle to send notifications regarding - * databases and infrastructure. + * Output only. The name of the DbVersion resource in the following format: + * projects/{project}/locations/{region}/dbVersions/{db_version} */ -@property(nonatomic, copy, nullable) NSString *email; +@property(nonatomic, copy, nullable) NSString *name; + +/** Output only. The properties of the DbVersion. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DbVersionProperties *properties; @end /** - * The connection string profile to allow clients to group. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile + * The properties of a DbVersion. */ -@interface GTLROracleDatabase_DatabaseConnectionStringProfile : GTLRObject +@interface GTLROracleDatabase_DbVersionProperties : GTLRObject /** - * Output only. The current consumer group being used by the connection. + * Output only. True if this version of the Oracle Database software is the + * latest version for a release. * - * Likely values: - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_ConsumerGroupUnspecified - * Default unspecified value. (Value: "CONSUMER_GROUP_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_High - * High consumer group. (Value: "HIGH") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Low - * Low consumer group. (Value: "LOW") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Medium - * Medium consumer group. (Value: "MEDIUM") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Tp - * TP consumer group. (Value: "TP") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_ConsumerGroup_Tpurgent - * TPURGENT consumer group. (Value: "TPURGENT") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *consumerGroup; - -/** Output only. The display name for the database connection. */ -@property(nonatomic, copy, nullable) NSString *displayName; +@property(nonatomic, strong, nullable) NSNumber *isLatestForMajorVersion; /** - * Output only. The host name format being currently used in connection string. + * Output only. True if this version of the Oracle Database software is the + * preview version. * - * Likely values: - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_HostFormat_Fqdn - * FQDN (Value: "FQDN") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_HostFormat_HostFormatUnspecified - * Default unspecified value. (Value: "HOST_FORMAT_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_HostFormat_Ip - * IP (Value: "IP") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *hostFormat; +@property(nonatomic, strong, nullable) NSNumber *isPreviewDbVersion; /** - * Output only. This field indicates if the connection string is regional and - * is only applicable for cross-region Data Guard. + * Output only. True if this version of the Oracle Database software is + * supported for Upgrade. * * Uses NSNumber of boolValue. */ -@property(nonatomic, strong, nullable) NSNumber *isRegional; +@property(nonatomic, strong, nullable) NSNumber *isUpgradeSupported; /** - * Output only. The protocol being used by the connection. + * Output only. True if this version of the Oracle Database software supports + * pluggable databases. * - * Likely values: - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_Protocol_ProtocolUnspecified - * Default unspecified value. (Value: "PROTOCOL_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_Protocol_Tcp - * Tcp (Value: "TCP") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_Protocol_Tcps - * Tcps (Value: "TCPS") + * Uses NSNumber of boolValue. */ -@property(nonatomic, copy, nullable) NSString *protocol; +@property(nonatomic, strong, nullable) NSNumber *supportsPdb; + +/** Output only. A valid Oracle Database version. */ +@property(nonatomic, copy, nullable) NSString *version; + +@end -/** - * Output only. The current session mode of the connection. - * - * Likely values: - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SessionMode_Direct - * Direct (Value: "DIRECT") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SessionMode_Indirect - * Indirect (Value: "INDIRECT") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SessionMode_SessionModeUnspecified - * Default unspecified value. (Value: "SESSION_MODE_UNSPECIFIED") - */ -@property(nonatomic, copy, nullable) NSString *sessionMode; /** - * Output only. The syntax of the connection string. - * - * Likely values: - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_Ezconnect - * Ezconnect (Value: "EZCONNECT") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_Ezconnectplus - * Ezconnectplus (Value: "EZCONNECTPLUS") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_Long - * Long (Value: "LONG") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_SyntaxFormat_SyntaxFormatUnspecified - * Default unspecified value. (Value: "SYNTAX_FORMAT_UNSPECIFIED") + * Wrapper message for the value of a defined tag. */ -@property(nonatomic, copy, nullable) NSString *syntaxFormat; +@interface GTLROracleDatabase_DefinedTagValue : GTLRObject + +/** The tags within the namespace. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DefinedTagValue_Tags *tags; + +@end + /** - * Output only. This field indicates the TLS authentication type of the - * connection. + * The tags within the namespace. * - * Likely values: - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_Mutual - * Mutual (Value: "MUTUAL") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_Server - * Server (Value: "SERVER") - * @arg @c kGTLROracleDatabase_DatabaseConnectionStringProfile_TlsAuthentication_TlsAuthenticationUnspecified - * Default unspecified value. (Value: "TLS_AUTHENTICATION_UNSPECIFIED") + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@property(nonatomic, copy, nullable) NSString *tlsAuthentication; +@interface GTLROracleDatabase_DefinedTagValue_Tags : GTLRObject +@end -/** Output only. The value of the connection string. */ -@property(nonatomic, copy, nullable) NSString *value; +/** + * 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); } + */ +@interface GTLROracleDatabase_Empty : GTLRObject @end /** - * Data collection options for diagnostics. + * The encryption key used to encrypt the Autonomous Database. */ -@interface GTLROracleDatabase_DataCollectionOptions : GTLRObject +@interface GTLROracleDatabase_EncryptionKey : GTLRObject /** - * Optional. Indicates whether diagnostic collection is enabled for the VM - * cluster - * - * Uses NSNumber of boolValue. + * Optional. The KMS key used to encrypt the Autonomous Database. This field is + * required if the provider is GOOGLE_MANAGED. The name of the KMS key resource + * in the following format: + * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */ -@property(nonatomic, strong, nullable) NSNumber *diagnosticsEventsEnabled; +@property(nonatomic, copy, nullable) NSString *kmsKey; /** - * Optional. Indicates whether health monitoring is enabled for the VM cluster + * Optional. The provider of the encryption key. * - * Uses NSNumber of boolValue. + * Likely values: + * @arg @c kGTLROracleDatabase_EncryptionKey_Provider_GoogleManaged Google + * Managed KMS key, if selected, please provide the KMS key name. (Value: + * "GOOGLE_MANAGED") + * @arg @c kGTLROracleDatabase_EncryptionKey_Provider_OracleManaged Oracle + * Managed. (Value: "ORACLE_MANAGED") + * @arg @c kGTLROracleDatabase_EncryptionKey_Provider_ProviderUnspecified + * Default unspecified value. (Value: "PROVIDER_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *healthMonitoringEnabled; +@property(nonatomic, copy, nullable) NSString *provider; + +@end + /** - * Optional. Indicates whether incident logs and trace collection are enabled - * for the VM cluster - * - * Uses NSNumber of boolValue. + * The history of the encryption keys used to encrypt the Autonomous Database. */ -@property(nonatomic, strong, nullable) NSNumber *incidentLogsEnabled; +@interface GTLROracleDatabase_EncryptionKeyHistoryEntry : GTLRObject + +/** + * Output only. The date and time when the encryption key was activated on the + * Autonomous Database.. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *activationTime; + +/** + * Output only. The encryption key used to encrypt the Autonomous Database. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_EncryptionKey *encryptionKey; @end /** - * Details of the database node resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/ + * Details of the Entitlement resource. */ -@interface GTLROracleDatabase_DbNode : GTLRObject +@interface GTLROracleDatabase_Entitlement : GTLRObject + +/** Details of the OCI Cloud Account. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudAccountDetails *cloudAccountDetails; + +/** Output only. Google Cloud Marketplace order ID (aka entitlement ID) */ +@property(nonatomic, copy, nullable) NSString *entitlementId; /** - * Identifier. The name of the database node resource in the following format: - * projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node} + * Identifier. The name of the Entitlement resource with the format: + * projects/{project}/locations/{region}/entitlements/{entitlement} */ @property(nonatomic, copy, nullable) NSString *name; -/** Optional. Various properties of the database node. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_DbNodeProperties *properties; +/** + * Output only. Entitlement State. + * + * Likely values: + * @arg @c kGTLROracleDatabase_Entitlement_State_AccountNotActive Account is + * linked but not active. (Value: "ACCOUNT_NOT_ACTIVE") + * @arg @c kGTLROracleDatabase_Entitlement_State_AccountNotLinked Account not + * linked. (Value: "ACCOUNT_NOT_LINKED") + * @arg @c kGTLROracleDatabase_Entitlement_State_AccountSuspended Account is + * suspended. (Value: "ACCOUNT_SUSPENDED") + * @arg @c kGTLROracleDatabase_Entitlement_State_Active Entitlement and + * Account are active. (Value: "ACTIVE") + * @arg @c kGTLROracleDatabase_Entitlement_State_NotApprovedInPrivateMarketplace + * Entitlement is not approved in private marketplace. (Value: + * "NOT_APPROVED_IN_PRIVATE_MARKETPLACE") + * @arg @c kGTLROracleDatabase_Entitlement_State_StateUnspecified Default + * unspecified value. (Value: "STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *state; @end /** - * Various properties and settings associated with Db node. + * ExadbVmCluster represents a cluster of VMs that are used to run Exadata + * workloads. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/ */ -@interface GTLROracleDatabase_DbNodeProperties : GTLRObject +@interface GTLROracleDatabase_ExadbVmCluster : GTLRObject -/** Output only. The date and time that the database node was created. */ +/** + * Required. Immutable. The name of the backup OdbSubnet associated with the + * ExadbVmCluster. Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + */ +@property(nonatomic, copy, nullable) NSString *backupOdbSubnet; + +/** Output only. The date and time that the ExadbVmCluster was created. */ @property(nonatomic, strong, nullable) GTLRDateTime *createTime; /** - * Optional. Local storage per database node. - * - * Uses NSNumber of intValue. + * Required. Immutable. The display name for the ExadbVmCluster. The name does + * not have to be unique within your project. The name must be 1-255 characters + * long and can only contain alphanumeric characters. */ -@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; - -/** Optional. Database server OCID. */ -@property(nonatomic, copy, nullable) NSString *dbServerOcid; +@property(nonatomic, copy, nullable) NSString *displayName; -/** Optional. DNS */ -@property(nonatomic, copy, nullable) NSString *hostname; +/** + * Output only. The ID of the subscription entitlement associated with the + * ExadbVmCluster. + */ +@property(nonatomic, copy, nullable) NSString *entitlementId; /** - * Memory allocated in GBs. - * - * Uses NSNumber of intValue. + * Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is + * hosted. Example: us-east4-b-r2. During creation, the system will pick the + * zone assigned to the ExascaleDbStorageVault. */ -@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; -/** Output only. OCID of database node. */ -@property(nonatomic, copy, nullable) NSString *ocid; +/** Optional. The labels or tags associated with the ExadbVmCluster. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_ExadbVmCluster_Labels *labels; /** - * Optional. OCPU count per database node. - * - * Uses NSNumber of intValue. + * Identifier. The name of the ExadbVmCluster resource in the following format: + * projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster} */ -@property(nonatomic, strong, nullable) NSNumber *ocpuCount; +@property(nonatomic, copy, nullable) NSString *name; /** - * Output only. State of the database node. - * - * Likely values: - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Available Indicates - * that the resource is in available state. (Value: "AVAILABLE") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Failed Indicates that - * the resource is in failed state. (Value: "FAILED") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Provisioning Indicates - * that the resource is in provisioning state. (Value: "PROVISIONING") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Starting Indicates that - * the resource is in starting state. (Value: "STARTING") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_StateUnspecified - * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Stopped Indicates that - * the resource is in stopped state. (Value: "STOPPED") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Stopping Indicates that - * the resource is in stopping state. (Value: "STOPPING") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Terminated Indicates - * that the resource is in terminated state. (Value: "TERMINATED") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Terminating Indicates - * that the resource is in terminating state. (Value: "TERMINATING") - * @arg @c kGTLROracleDatabase_DbNodeProperties_State_Updating Indicates that - * the resource is in updating state. (Value: "UPDATING") + * Optional. Immutable. The name of the OdbNetwork associated with the + * ExadbVmCluster. Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network} It is + * optional but if specified, this should match the parent ODBNetwork of the + * OdbSubnet. */ -@property(nonatomic, copy, nullable) NSString *state; +@property(nonatomic, copy, nullable) NSString *odbNetwork; /** - * Total CPU core count of the database node. - * - * Uses NSNumber of intValue. + * Required. Immutable. The name of the OdbSubnet associated with the + * ExadbVmCluster for IP allocation. Format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} */ -@property(nonatomic, strong, nullable) NSNumber *totalCpuCoreCount; +@property(nonatomic, copy, nullable) NSString *odbSubnet; + +/** Required. The properties of the ExadbVmCluster. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_ExadbVmClusterProperties *properties; @end /** - * Details of the database server resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/ + * Optional. The labels or tags associated with the ExadbVmCluster. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@interface GTLROracleDatabase_DbServer : GTLRObject +@interface GTLROracleDatabase_ExadbVmCluster_Labels : GTLRObject +@end -/** Optional. User friendly name for this resource. */ -@property(nonatomic, copy, nullable) NSString *displayName; /** - * Identifier. The name of the database server resource with the format: - * projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} + * The properties of an ExadbVmCluster. */ -@property(nonatomic, copy, nullable) NSString *name; - -/** Optional. Various properties of the database server. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_DbServerProperties *properties; - -@end +@interface GTLROracleDatabase_ExadbVmClusterProperties : GTLRObject +/** + * Optional. Immutable. The number of additional ECPUs per node for an Exadata + * VM cluster on exascale infrastructure. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *additionalEcpuCountPerNode; /** - * Various properties and settings associated with Exadata database server. + * Optional. Immutable. The cluster name for Exascale vm cluster. The cluster + * name must begin with an alphabetic character and may contain hyphens(-) but + * can not contain underscores(_). It should be not more than 11 characters and + * is not case sensitive. OCI Cluster name. */ -@interface GTLROracleDatabase_DbServerProperties : GTLRObject +@property(nonatomic, copy, nullable) NSString *clusterName; /** - * Output only. OCID of database nodes associated with the database server. + * Optional. Immutable. Indicates user preference for data collection options. */ -@property(nonatomic, strong, nullable) NSArray *dbNodeIds; +@property(nonatomic, strong, nullable) GTLROracleDatabase_DataCollectionOptionsCommon *dataCollectionOptions; /** - * Optional. Local storage per VM. + * Required. Immutable. The number of ECPUs enabled per node for an exadata vm + * cluster on exascale infrastructure. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *dbNodeStorageSizeGb; +@property(nonatomic, strong, nullable) NSNumber *enabledEcpuCountPerNode; /** - * Optional. Maximum local storage per VM. + * Required. Immutable. The name of ExascaleDbStorageVault associated with the + * ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new + * one can be created during the ExadbVmCluster creation (requires + * storage_vault_properties to be set). Format: + * projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault} + */ +@property(nonatomic, copy, nullable) NSString *exascaleDbStorageVault; + +/** Output only. The Oracle Grid Infrastructure (GI) software version. */ +@property(nonatomic, copy, nullable) NSString *giVersion; + +/** Required. Immutable. Grid Infrastructure Version. */ +@property(nonatomic, copy, nullable) NSString *gridImageId; + +/** Output only. The hostname of the ExadbVmCluster. */ +@property(nonatomic, copy, nullable) NSString *hostname; + +/** Required. Immutable. Prefix for VM cluster host names. */ +@property(nonatomic, copy, nullable) NSString *hostnamePrefix; + +/** + * Optional. Immutable. The license type of the ExadbVmCluster. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_BringYourOwnLicense + * Bring your own license. (Value: "BRING_YOUR_OWN_LICENSE") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_LicenseIncluded + * Default is license included. (Value: "LICENSE_INCLUDED") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LicenseModel_LicenseModelUnspecified + * Unspecified. (Value: "LICENSE_MODEL_UNSPECIFIED") */ -@property(nonatomic, strong, nullable) NSNumber *maxDbNodeStorageSizeGb; +@property(nonatomic, copy, nullable) NSString *licenseModel; /** - * Optional. Maximum memory allocated in GBs. + * Output only. State of the cluster. * - * Uses NSNumber of intValue. + * Likely values: + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Available + * Indicates that the resource is in available state. (Value: + * "AVAILABLE") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_ExadbVmClusterLifecycleStateUnspecified + * Default unspecified value. (Value: + * "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Failed + * Indicates that the resource is in failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_MaintenanceInProgress + * Indicates that the resource is in maintenance in progress state. + * (Value: "MAINTENANCE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Provisioning + * Indicates that the resource is in provisioning state. (Value: + * "PROVISIONING") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Terminated + * Indicates that the resource is in terminated state. (Value: + * "TERMINATED") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Terminating + * Indicates that the resource is in terminating state. (Value: + * "TERMINATING") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_LifecycleState_Updating + * Indicates that the resource is in updating state. (Value: "UPDATING") */ -@property(nonatomic, strong, nullable) NSNumber *maxMemorySizeGb; +@property(nonatomic, copy, nullable) NSString *lifecycleState; /** - * Optional. Maximum OCPU count per database. + * Output only. Memory per VM (GB) (Read-only): Shows the amount of memory + * allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *maxOcpuCount; +@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; /** - * Optional. Memory allocated in GBs. + * Required. The number of nodes/VMs in the ExadbVmCluster. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *memorySizeGb; +@property(nonatomic, strong, nullable) NSNumber *nodeCount; -/** Output only. OCID of database server. */ -@property(nonatomic, copy, nullable) NSString *ocid; +/** Output only. Deep link to the OCI console to view this resource. */ +@property(nonatomic, copy, nullable) NSString *ociUri; /** - * Optional. OCPU count per database. + * Optional. Immutable. SCAN listener port - TCP * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *ocpuCount; +@property(nonatomic, strong, nullable) NSNumber *scanListenerPortTcp; /** - * Output only. State of the database server. + * Required. Immutable. The shape attribute of the VM cluster. The type of + * Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE + * which supports Oracle Database 23ai and later * * Likely values: - * @arg @c kGTLROracleDatabase_DbServerProperties_State_Available Indicates - * that the resource is in available state. (Value: "AVAILABLE") - * @arg @c kGTLROracleDatabase_DbServerProperties_State_Creating Indicates - * that the resource is in creating state. (Value: "CREATING") - * @arg @c kGTLROracleDatabase_DbServerProperties_State_Deleted Indicates - * that the resource is in deleted state. (Value: "DELETED") - * @arg @c kGTLROracleDatabase_DbServerProperties_State_Deleting Indicates - * that the resource is in deleting state. (Value: "DELETING") - * @arg @c kGTLROracleDatabase_DbServerProperties_State_StateUnspecified - * Default unspecified value. (Value: "STATE_UNSPECIFIED") - * @arg @c kGTLROracleDatabase_DbServerProperties_State_Unavailable Indicates - * that the resource is in unavailable state. (Value: "UNAVAILABLE") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_BlockStorage + * Indicates that the resource is in block storage. (Value: + * "BLOCK_STORAGE") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_ShapeAttributeUnspecified + * Default unspecified value. (Value: "SHAPE_ATTRIBUTE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_ExadbVmClusterProperties_ShapeAttribute_SmartStorage + * Indicates that the resource is in smart storage. (Value: + * "SMART_STORAGE") + */ +@property(nonatomic, copy, nullable) NSString *shapeAttribute; + +/** Required. Immutable. The SSH public keys for the ExadbVmCluster. */ +@property(nonatomic, strong, nullable) NSArray *sshPublicKeys; + +/** Optional. Immutable. The time zone of the ExadbVmCluster. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_TimeZone *timeZone; + +/** Required. Immutable. Total storage details for the ExadbVmCluster. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_ExadbVmClusterStorageDetails *vmFileSystemStorage; + +@end + + +/** + * The storage allocation for the exadbvmcluster, in gigabytes (GB). */ -@property(nonatomic, copy, nullable) NSString *state; +@interface GTLROracleDatabase_ExadbVmClusterStorageDetails : GTLRObject /** - * Optional. Vm count per database. + * Required. The storage allocation for the exadbvmcluster per node, in + * gigabytes (GB). This field is used to calculate the total storage allocation + * for the exadbvmcluster. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *vmCount; +@property(nonatomic, strong, nullable) NSNumber *sizeInGbsPerNode; @end /** - * Details of the Database System Shapes resource. - * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ + * The storage details of the ExascaleDbStorageVault. */ -@interface GTLROracleDatabase_DbSystemShape : GTLRObject +@interface GTLROracleDatabase_ExascaleDbStorageDetails : GTLRObject /** - * Optional. Number of cores per node. + * Output only. The available storage capacity for the ExascaleDbStorageVault, + * in gigabytes (GB). * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *availableCoreCountPerNode; +@property(nonatomic, strong, nullable) NSNumber *availableSizeGbs; + +/** + * Required. The total storage allocation for the ExascaleDbStorageVault, in + * gigabytes (GB). + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *totalSizeGbs; + +@end + + +/** + * ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/ + */ +@interface GTLROracleDatabase_ExascaleDbStorageVault : GTLRObject + +/** + * Output only. The date and time when the ExascaleDbStorageVault was created. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Required. The display name for the ExascaleDbStorageVault. The name does not + * have to be unique within your project. The name must be 1-255 characters + * long and can only contain alphanumeric characters. + */ +@property(nonatomic, copy, nullable) NSString *displayName; /** - * Optional. Storage per storage server in terabytes. - * - * Uses NSNumber of intValue. + * Output only. The ID of the subscription entitlement associated with the + * ExascaleDbStorageVault. */ -@property(nonatomic, strong, nullable) NSNumber *availableDataStorageTb; +@property(nonatomic, copy, nullable) NSString *entitlementId; /** - * Optional. Memory per database server node in gigabytes. - * - * Uses NSNumber of intValue. + * Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. + * Example: us-east4-b-r2. If not specified, the system will pick a zone based + * on availability. */ -@property(nonatomic, strong, nullable) NSNumber *availableMemoryPerNodeGb; +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; /** - * Optional. Maximum number of database servers. - * - * Uses NSNumber of intValue. + * Optional. The labels or tags associated with the ExascaleDbStorageVault. */ -@property(nonatomic, strong, nullable) NSNumber *maxNodeCount; +@property(nonatomic, strong, nullable) GTLROracleDatabase_ExascaleDbStorageVault_Labels *labels; /** - * Optional. Maximum number of storage servers. - * - * Uses NSNumber of intValue. + * Identifier. The resource name of the ExascaleDbStorageVault. Format: + * projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault} */ -@property(nonatomic, strong, nullable) NSNumber *maxStorageCount; +@property(nonatomic, copy, nullable) NSString *name; + +/** Required. The properties of the ExascaleDbStorageVault. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_ExascaleDbStorageVaultProperties *properties; + +@end + /** - * Optional. Minimum core count per node. + * Optional. The labels or tags associated with the ExascaleDbStorageVault. * - * Uses NSNumber of intValue. + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. */ -@property(nonatomic, strong, nullable) NSNumber *minCoreCountPerNode; +@interface GTLROracleDatabase_ExascaleDbStorageVault_Labels : GTLRObject +@end + /** - * Optional. Minimum node storage per database server in gigabytes. - * - * Uses NSNumber of intValue. + * The properties of the ExascaleDbStorageVault. next ID: 12 */ -@property(nonatomic, strong, nullable) NSNumber *minDbNodeStoragePerNodeGb; +@interface GTLROracleDatabase_ExascaleDbStorageVaultProperties : GTLRObject /** - * Optional. Minimum memory per node in gigabytes. + * Optional. The size of additional flash cache in percentage of high capacity + * database storage. * * Uses NSNumber of intValue. */ -@property(nonatomic, strong, nullable) NSNumber *minMemoryPerNodeGb; +@property(nonatomic, strong, nullable) NSNumber *additionalFlashCachePercent; /** - * Optional. Minimum number of database servers. - * - * Uses NSNumber of intValue. + * Output only. The shape attributes of the VM clusters attached to the + * ExascaleDbStorageVault. */ -@property(nonatomic, strong, nullable) NSNumber *minNodeCount; +@property(nonatomic, strong, nullable) NSArray *attachedShapeAttributes; /** - * Optional. Minimum number of storage servers. - * - * Uses NSNumber of intValue. + * Output only. The shape attributes available for the VM clusters to be + * attached to the ExascaleDbStorageVault. */ -@property(nonatomic, strong, nullable) NSNumber *minStorageCount; +@property(nonatomic, strong, nullable) NSArray *availableShapeAttributes; /** - * Identifier. The name of the Database System Shape resource with the format: - * projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape} + * Optional. The description of the ExascaleDbStorageVault. + * + * Remapped to 'descriptionProperty' to avoid NSObject's 'description'. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, copy, nullable) NSString *descriptionProperty; -/** Optional. shape */ -@property(nonatomic, copy, nullable) NSString *shape; +/** Required. The storage details of the ExascaleDbStorageVault. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_ExascaleDbStorageDetails *exascaleDbStorageDetails; -@end +/** Output only. The OCID for the ExascaleDbStorageVault. */ +@property(nonatomic, copy, nullable) NSString *ocid; +/** Output only. Deep link to the OCI console to view this resource. */ +@property(nonatomic, copy, nullable) NSString *ociUri; /** - * 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); } + * Output only. The state of the ExascaleDbStorageVault. + * + * Likely values: + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Available + * The ExascaleDbStorageVault is available. (Value: "AVAILABLE") + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Failed + * The ExascaleDbStorageVault has failed. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Provisioning + * The ExascaleDbStorageVault is being provisioned. (Value: + * "PROVISIONING") + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_StateUnspecified + * The state of the ExascaleDbStorageVault is unspecified. (Value: + * "STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Terminated + * The ExascaleDbStorageVault has been deleted. (Value: "TERMINATED") + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Terminating + * The ExascaleDbStorageVault is being deleted. (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_ExascaleDbStorageVaultProperties_State_Updating + * The ExascaleDbStorageVault is being updated. (Value: "UPDATING") */ -@interface GTLROracleDatabase_Empty : GTLRObject -@end +@property(nonatomic, copy, nullable) NSString *state; +/** Output only. The time zone of the ExascaleDbStorageVault. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_TimeZone *timeZone; /** - * Details of the Entitlement resource. + * Output only. The number of VM clusters associated with the + * ExascaleDbStorageVault. + * + * Uses NSNumber of intValue. */ -@interface GTLROracleDatabase_Entitlement : GTLRObject - -/** Details of the OCI Cloud Account. */ -@property(nonatomic, strong, nullable) GTLROracleDatabase_CloudAccountDetails *cloudAccountDetails; - -/** Output only. Google Cloud Marketplace order ID (aka entitlement ID) */ -@property(nonatomic, copy, nullable) NSString *entitlementId; +@property(nonatomic, strong, nullable) NSNumber *vmClusterCount; /** - * Identifier. The name of the Entitlement resource with the format: - * projects/{project}/locations/{region}/entitlements/{entitlement} + * Output only. The list of VM cluster OCIDs associated with the + * ExascaleDbStorageVault. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, strong, nullable) NSArray *vmClusterIds; + +@end + /** - * Output only. Entitlement State. - * - * Likely values: - * @arg @c kGTLROracleDatabase_Entitlement_State_AccountNotActive Account is - * linked but not active. (Value: "ACCOUNT_NOT_ACTIVE") - * @arg @c kGTLROracleDatabase_Entitlement_State_AccountNotLinked Account not - * linked. (Value: "ACCOUNT_NOT_LINKED") - * @arg @c kGTLROracleDatabase_Entitlement_State_AccountSuspended Account is - * suspended. (Value: "ACCOUNT_SUSPENDED") - * @arg @c kGTLROracleDatabase_Entitlement_State_Active Entitlement and - * Account are active. (Value: "ACTIVE") - * @arg @c kGTLROracleDatabase_Entitlement_State_NotApprovedInPrivateMarketplace - * Entitlement is not approved in private marketplace. (Value: - * "NOT_APPROVED_IN_PRIVATE_MARKETPLACE") - * @arg @c kGTLROracleDatabase_Entitlement_State_StateUnspecified Default - * unspecified value. (Value: "STATE_UNSPECIFIED") + * The request for `OracleDatabase.FailoverAutonomousDatabase`. */ -@property(nonatomic, copy, nullable) NSString *state; +@interface GTLROracleDatabase_FailoverAutonomousDatabaseRequest : GTLRObject + +/** Required. The peer database name to fail over to. */ +@property(nonatomic, copy, nullable) NSString *peerAutonomousDatabase; @end @@ -4223,84 +6702,252 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails @interface GTLROracleDatabase_ListCloudExadataInfrastructuresResponse : GTLRCollectionObject /** - * The list of Exadata Infrastructures. + * The list of Exadata Infrastructures. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *cloudExadataInfrastructures; + +/** A token for fetching next page of response. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `CloudVmCluster.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "cloudVmClusters" property. If returned as the result of a query, + * it should support automatic pagination (when @c shouldFetchNextPages + * is enabled). + */ +@interface GTLROracleDatabase_ListCloudVmClustersResponse : GTLRCollectionObject + +/** + * The list of VM Clusters. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *cloudVmClusters; + +/** A token to fetch the next page of results. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `DatabaseCharacterSet.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "databaseCharacterSets" property. If returned as the result of a + * query, it should support automatic pagination (when @c + * shouldFetchNextPages is enabled). + */ +@interface GTLROracleDatabase_ListDatabaseCharacterSetsResponse : GTLRCollectionObject + +/** + * The list of DatabaseCharacterSets. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *databaseCharacterSets; + +/** A token identifying a page of results the server should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `Database.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "databases" property. If returned as the result of a query, it + * should support automatic pagination (when @c shouldFetchNextPages is + * enabled). + */ +@interface GTLROracleDatabase_ListDatabasesResponse : GTLRCollectionObject + +/** + * The list of Databases. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *databases; + +/** A token identifying a page of results the server should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `DbNode.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "dbNodes" property. If returned as the result of a query, it + * should support automatic pagination (when @c shouldFetchNextPages is + * enabled). + */ +@interface GTLROracleDatabase_ListDbNodesResponse : GTLRCollectionObject + +/** + * The list of DB Nodes + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *dbNodes; + +/** A token identifying a page of results the node should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `DbServer.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "dbServers" property. If returned as the result of a query, it + * should support automatic pagination (when @c shouldFetchNextPages is + * enabled). + */ +@interface GTLROracleDatabase_ListDbServersResponse : GTLRCollectionObject + +/** + * The list of database servers. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *dbServers; + +/** A token identifying a page of results the server should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `DbSystemInitialStorageSizes.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "dbSystemInitialStorageSizes" property. If returned as the result + * of a query, it should support automatic pagination (when @c + * shouldFetchNextPages is enabled). + */ +@interface GTLROracleDatabase_ListDbSystemInitialStorageSizesResponse : GTLRCollectionObject + +/** + * The list of DbSystemInitialStorageSizes. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *dbSystemInitialStorageSizes; + +/** A token identifying a page of results the server should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + +/** + * The response for `DbSystemShape.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "dbSystemShapes" property. If returned as the result of a query, + * it should support automatic pagination (when @c shouldFetchNextPages + * is enabled). + */ +@interface GTLROracleDatabase_ListDbSystemShapesResponse : GTLRCollectionObject + +/** + * The list of Database System shapes. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSArray *cloudExadataInfrastructures; +@property(nonatomic, strong, nullable) NSArray *dbSystemShapes; -/** A token for fetching next page of response. */ +/** A token identifying a page of results the server should return. */ @property(nonatomic, copy, nullable) NSString *nextPageToken; @end /** - * The response for `CloudVmCluster.List`. + * The response for `DbSystem.List`. * * @note This class supports NSFastEnumeration and indexed subscripting over - * its "cloudVmClusters" property. If returned as the result of a query, - * it should support automatic pagination (when @c shouldFetchNextPages - * is enabled). + * its "dbSystems" property. If returned as the result of a query, it + * should support automatic pagination (when @c shouldFetchNextPages is + * enabled). */ -@interface GTLROracleDatabase_ListCloudVmClustersResponse : GTLRCollectionObject +@interface GTLROracleDatabase_ListDbSystemsResponse : GTLRCollectionObject /** - * The list of VM Clusters. + * The list of DbSystems. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSArray *cloudVmClusters; +@property(nonatomic, strong, nullable) NSArray *dbSystems; -/** A token to fetch the next page of results. */ +/** A token identifying a page of results the server should return. */ @property(nonatomic, copy, nullable) NSString *nextPageToken; @end /** - * The response for `DbNode.List`. + * The response for `DbVersions.List`. * * @note This class supports NSFastEnumeration and indexed subscripting over - * its "dbNodes" property. If returned as the result of a query, it + * its "dbVersions" property. If returned as the result of a query, it * should support automatic pagination (when @c shouldFetchNextPages is * enabled). */ -@interface GTLROracleDatabase_ListDbNodesResponse : GTLRCollectionObject +@interface GTLROracleDatabase_ListDbVersionsResponse : GTLRCollectionObject /** - * The list of DB Nodes + * The list of DbVersions. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSArray *dbNodes; +@property(nonatomic, strong, nullable) NSArray *dbVersions; -/** A token identifying a page of results the node should return. */ +/** A token identifying a page of results the server should return. */ @property(nonatomic, copy, nullable) NSString *nextPageToken; @end /** - * The response for `DbServer.List`. + * The response for `Entitlement.List`. * * @note This class supports NSFastEnumeration and indexed subscripting over - * its "dbServers" property. If returned as the result of a query, it + * its "entitlements" property. If returned as the result of a query, it * should support automatic pagination (when @c shouldFetchNextPages is * enabled). */ -@interface GTLROracleDatabase_ListDbServersResponse : GTLRCollectionObject +@interface GTLROracleDatabase_ListEntitlementsResponse : GTLRCollectionObject /** - * The list of database servers. + * The list of Entitlements * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSArray *dbServers; +@property(nonatomic, strong, nullable) NSArray *entitlements; /** A token identifying a page of results the server should return. */ @property(nonatomic, copy, nullable) NSString *nextPageToken; @@ -4309,22 +6956,22 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails /** - * The response for `DbSystemShape.List`. + * The response for `ExadbVmCluster.List`. * * @note This class supports NSFastEnumeration and indexed subscripting over - * its "dbSystemShapes" property. If returned as the result of a query, + * its "exadbVmClusters" property. If returned as the result of a query, * it should support automatic pagination (when @c shouldFetchNextPages * is enabled). */ -@interface GTLROracleDatabase_ListDbSystemShapesResponse : GTLRCollectionObject +@interface GTLROracleDatabase_ListExadbVmClustersResponse : GTLRCollectionObject /** - * The list of Database System shapes. + * The list of ExadbVmClusters. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSArray *dbSystemShapes; +@property(nonatomic, strong, nullable) NSArray *exadbVmClusters; /** A token identifying a page of results the server should return. */ @property(nonatomic, copy, nullable) NSString *nextPageToken; @@ -4333,24 +6980,29 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails /** - * The response for `Entitlement.List`. + * The response for `ExascaleDbStorageVault.List`. * * @note This class supports NSFastEnumeration and indexed subscripting over - * its "entitlements" property. If returned as the result of a query, it - * should support automatic pagination (when @c shouldFetchNextPages is - * enabled). + * its "exascaleDbStorageVaults" property. If returned as the result of a + * query, it should support automatic pagination (when @c + * shouldFetchNextPages is enabled). */ -@interface GTLROracleDatabase_ListEntitlementsResponse : GTLRCollectionObject +@interface GTLROracleDatabase_ListExascaleDbStorageVaultsResponse : GTLRCollectionObject /** - * The list of Entitlements + * The ExascaleDbStorageVaults. * * @note This property is used to support NSFastEnumeration and indexed * subscripting on this class. */ -@property(nonatomic, strong, nullable) NSArray *entitlements; +@property(nonatomic, strong, nullable) NSArray *exascaleDbStorageVaults; -/** A token identifying a page of results the server should return. */ +/** + * A token identifying a page of results the server should return. If present, + * the next page token can be provided to a subsequent + * ListExascaleDbStorageVaults call to list the next page. If empty, there are + * no more pages. + */ @property(nonatomic, copy, nullable) NSString *nextPageToken; @end @@ -4404,6 +7056,30 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails @end +/** + * The response for `MinorVersion.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "minorVersions" property. If returned as the result of a query, it + * should support automatic pagination (when @c shouldFetchNextPages is + * enabled). + */ +@interface GTLROracleDatabase_ListMinorVersionsResponse : GTLRCollectionObject + +/** + * The list of MinorVersions. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *minorVersions; + +/** A token identifying a page of results the server should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +@end + + /** * The response for `OdbNetwork.List`. * @@ -4485,6 +7161,37 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + +@end + + +/** + * The response for `PluggableDatabase.List`. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "pluggableDatabases" property. If returned as the result of a + * query, it should support automatic pagination (when @c + * shouldFetchNextPages is enabled). + */ +@interface GTLROracleDatabase_ListPluggableDatabasesResponse : GTLRCollectionObject + +/** A token identifying a page of results the server should return. */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +/** + * The list of PluggableDatabases. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *pluggableDatabases; + @end @@ -4653,6 +7360,27 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails @end +/** + * MinorVersion represents a minor version of a GI. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/ + */ +@interface GTLROracleDatabase_MinorVersion : GTLRObject + +/** Optional. The ID of the Grid Image. */ +@property(nonatomic, copy, nullable) NSString *gridImageId; + +/** + * Identifier. The name of the MinorVersion resource with the format: + * projects/{project}/locations/{region}/giVersions/{gi_version}/minorVersions/{minor_version} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Optional. The valid Oracle grid infrastructure software version. */ +@property(nonatomic, copy, nullable) NSString *version; + +@end + + /** * Represents OdbNetwork resource. */ @@ -4667,6 +7395,13 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails */ @property(nonatomic, copy, nullable) NSString *entitlementId; +/** + * Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: + * us-east4-b-r2. If not specified, the system will pick a zone based on + * availability. + */ +@property(nonatomic, copy, nullable) NSString *gcpOracleZone; + /** Optional. Labels or tags associated with the resource. */ @property(nonatomic, strong, nullable) GTLROracleDatabase_OdbNetwork_Labels *labels; @@ -4905,6 +7640,271 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails @end +/** + * The PluggableDatabase resource. + * https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/ + */ +@interface GTLROracleDatabase_PluggableDatabase : GTLRObject + +/** Output only. The date and time that the PluggableDatabase was created. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Identifier. The name of the PluggableDatabase resource in the following + * format: + * projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Output only. HTTPS link to OCI resources exposed to Customer via UI + * Interface. + */ +@property(nonatomic, copy, nullable) NSString *ociUrl; + +/** Optional. The properties of the PluggableDatabase. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_PluggableDatabaseProperties *properties; + +@end + + +/** + * The connection strings used to connect to the Oracle Database. + */ +@interface GTLROracleDatabase_PluggableDatabaseConnectionStrings : GTLRObject + +/** + * Optional. All connection strings to use to connect to the pluggable + * database. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_PluggableDatabaseConnectionStrings_AllConnectionStrings *allConnectionStrings; + +/** + * Optional. The default connection string to use to connect to the pluggable + * database. + */ +@property(nonatomic, copy, nullable) NSString *pdbDefault; + +/** + * Optional. The default connection string to use to connect to the pluggable + * database using IP. + */ +@property(nonatomic, copy, nullable) NSString *pdbIpDefault; + +@end + + +/** + * Optional. All connection strings to use to connect to the pluggable + * database. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLROracleDatabase_PluggableDatabaseConnectionStrings_AllConnectionStrings : GTLRObject +@end + + +/** + * The Pluggable Database Node Level Details. + */ +@interface GTLROracleDatabase_PluggableDatabaseNodeLevelDetails : GTLRObject + +/** Required. The Node name of the Database home. */ +@property(nonatomic, copy, nullable) NSString *nodeName; + +/** + * Required. The mode that the pluggable database is in to open it. + * + * Likely values: + * @arg @c kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_Migrate + * The pluggable database is migrated. (Value: "MIGRATE") + * @arg @c kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_Mounted + * The pluggable database is mounted. (Value: "MOUNTED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_PluggableDatabaseOpenModeUnspecified + * The open mode is unspecified. (Value: + * "PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_ReadOnly + * The pluggable database is opened in read-only mode. (Value: + * "READ_ONLY") + * @arg @c kGTLROracleDatabase_PluggableDatabaseNodeLevelDetails_OpenMode_ReadWrite + * The pluggable database is opened in read-write mode. (Value: + * "READ_WRITE") + */ +@property(nonatomic, copy, nullable) NSString *openMode; + +/** Required. The OCID of the Pluggable Database. */ +@property(nonatomic, copy, nullable) NSString *pluggableDatabaseId; + +@end + + +/** + * The properties of a PluggableDatabase. + */ +@interface GTLROracleDatabase_PluggableDatabaseProperties : GTLRObject + +/** Required. The OCID of the compartment. */ +@property(nonatomic, copy, nullable) NSString *compartmentId; + +/** + * Optional. The Connection strings used to connect to the Oracle Database. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_PluggableDatabaseConnectionStrings *connectionStrings; + +/** Required. The OCID of the CDB. */ +@property(nonatomic, copy, nullable) NSString *containerDatabaseOcid; + +/** Output only. The configuration of the Database Management service. */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_DatabaseManagementConfig *databaseManagementConfig; + +/** + * Optional. Defined tags for this resource. Each key is predefined and scoped + * to a namespace. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_PluggableDatabaseProperties_DefinedTags *definedTags; + +/** + * Optional. Free-form tags for this resource. Each tag is a simple key-value + * pair with no predefined name, type, or namespace. + */ +@property(nonatomic, strong, nullable) GTLROracleDatabase_PluggableDatabaseProperties_FreeformTags *freeformTags; + +/** + * Optional. The restricted mode of the pluggable database. If a pluggable + * database is opened in restricted mode, the user needs both create a session + * and have restricted session privileges to connect to it. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *isRestricted; + +/** Output only. Additional information about the current lifecycle state. */ +@property(nonatomic, copy, nullable) NSString *lifecycleDetails; + +/** + * Output only. The current state of the pluggable database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Available + * The pluggable database is available. (Value: "AVAILABLE") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_BackupInProgress + * The pluggable database is backing up. (Value: "BACKUP_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Disabled + * The pluggable database is disabled. (Value: "DISABLED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Failed + * The pluggable database is in a failed state. (Value: "FAILED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_PluggableDatabaseLifecycleStateUnspecified + * The lifecycle state is unspecified. (Value: + * "PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Provisioning + * The pluggable database is provisioning. (Value: "PROVISIONING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Refreshing + * The pluggable database is refreshing. (Value: "REFRESHING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Relocated + * The pluggable database is relocated. (Value: "RELOCATED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Relocating + * The pluggable database is relocating. (Value: "RELOCATING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_RestoreFailed + * The pluggable database restore failed. (Value: "RESTORE_FAILED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_RestoreInProgress + * The pluggable database is restoring. (Value: "RESTORE_IN_PROGRESS") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Terminated + * The pluggable database is terminated. (Value: "TERMINATED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Terminating + * The pluggable database is terminating. (Value: "TERMINATING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_LifecycleState_Updating + * The pluggable database is updating. (Value: "UPDATING") + */ +@property(nonatomic, copy, nullable) NSString *lifecycleState; + +/** Output only. The OCID of the pluggable database. */ +@property(nonatomic, copy, nullable) NSString *ocid; + +/** + * Output only. The status of Operations Insights for this Database. + * + * Likely values: + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Disabling + * Operations Insights is disabling. (Value: "DISABLING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Enabled + * Operations Insights is enabled. (Value: "ENABLED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_Enabling + * Operations Insights is enabling. (Value: "ENABLING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_FailedDisabling + * Operations Insights failed to disable. (Value: "FAILED_DISABLING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_FailedEnabling + * Operations Insights failed to enable. (Value: "FAILED_ENABLING") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_NotEnabled + * Operations Insights is not enabled. (Value: "NOT_ENABLED") + * @arg @c kGTLROracleDatabase_PluggableDatabaseProperties_OperationsInsightsState_OperationsInsightsStateUnspecified + * The status is not specified. (Value: + * "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *operationsInsightsState; + +/** Required. The database name. */ +@property(nonatomic, copy, nullable) NSString *pdbName; + +/** Optional. Pluggable Database Node Level Details */ +@property(nonatomic, strong, nullable) NSArray *pdbNodeLevelDetails; + +@end + + +/** + * Optional. Defined tags for this resource. Each key is predefined and scoped + * to a namespace. + * + * @note This class is documented as having more properties of + * GTLROracleDatabase_DefinedTagValue. Use @c -additionalJSONKeys and @c + * -additionalPropertyForName: to get the list of properties and then + * fetch them; or @c -additionalProperties to fetch them all at once. + */ +@interface GTLROracleDatabase_PluggableDatabaseProperties_DefinedTags : GTLRObject +@end + + +/** + * Optional. Free-form tags for this resource. Each tag is a simple key-value + * pair with no predefined name, type, or namespace. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLROracleDatabase_PluggableDatabaseProperties_FreeformTags : GTLRObject +@end + + +/** + * The request for `ExadbVmCluster.RemoveVirtualMachine`. + */ +@interface GTLROracleDatabase_RemoveVirtualMachineExadbVmClusterRequest : GTLRObject + +/** + * Required. The list of host names of db nodes to be removed from the + * ExadbVmCluster. + */ +@property(nonatomic, strong, nullable) NSArray *hostnames; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +@end + + /** * The request for `AutonomousDatabase.Restart`. */ @@ -5042,6 +8042,31 @@ FOUNDATION_EXTERN NSString * const kGTLROracleDatabase_ScheduledOperationDetails @end +/** + * The initial storage size, in gigabytes, that is applicable for virtual + * machine DBSystem. + */ +@interface GTLROracleDatabase_StorageSizeDetails : GTLRObject + +/** + * Output only. The data storage size, in gigabytes, that is applicable for + * virtual machine DBSystem. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *dataStorageSizeInGbs; + +/** + * Output only. The RECO/REDO storage size, in gigabytes, that is applicable + * for virtual machine DBSystem. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *recoStorageSizeInGbs; + +@end + + /** * The request for `OracleDatabase.SwitchoverAutonomousDatabase`. */ diff --git a/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseQuery.h b/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseQuery.h index f1e4a744d..5ceda3b0a 100644 --- a/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseQuery.h +++ b/Sources/GeneratedServices/OracleDatabase/Public/GoogleAPIClientForREST/GTLROracleDatabaseQuery.h @@ -237,6 +237,42 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Initiates a failover to target autonomous database from the associated + * primary database. + * + * Method: oracledatabase.projects.locations.autonomousDatabases.failover + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesFailover : GTLROracleDatabaseQuery + +/** + * Required. The name of the Autonomous Database in the following format: + * projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Initiates a failover to target autonomous database from the associated + * primary database. + * + * @param object The @c GTLROracleDatabase_FailoverAutonomousDatabaseRequest to + * include in the query. + * @param name Required. The name of the Autonomous Database in the following + * format: + * projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesFailover + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_FailoverAutonomousDatabaseRequest *)object + name:(NSString *)name; + +@end + /** * Generates a wallet for an Autonomous Database. * @@ -355,6 +391,63 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Updates the parameters of a single Autonomous Database. + * + * Method: oracledatabase.projects.locations.autonomousDatabases.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesPatch : GTLROracleDatabaseQuery + +/** + * Identifier. The name of the Autonomous Database resource in the following + * format: + * projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Optional. Field mask is used to specify the fields to be overwritten in the + * Exadata resource by the update. The fields specified in the update_mask are + * relative to the resource, not the full request. A field will be overwritten + * if it is in the mask. If the user does not provide a mask then all fields + * will be overwritten. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Updates the parameters of a single Autonomous Database. + * + * @param object The @c GTLROracleDatabase_AutonomousDatabase to include in the + * query. + * @param name Identifier. The name of the Autonomous Database resource in the + * following format: + * projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsAutonomousDatabasesPatch + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_AutonomousDatabase *)object + name:(NSString *)name; + +@end + /** * Restarts an Autonomous Database. * @@ -766,6 +859,12 @@ NS_ASSUME_NONNULL_BEGIN */ @interface GTLROracleDatabaseQuery_ProjectsLocationsCloudExadataInfrastructuresList : GTLROracleDatabaseQuery +/** Optional. An expression for filtering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** Optional. An expression for ordering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *orderBy; + /** * Optional. The maximum number of items to return. If unspecified, at most 50 * Exadata infrastructures will be returned. The maximum value is 1000; values @@ -1027,42 +1126,54 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Lists the database system shapes available for the project and location. + * List DatabaseCharacterSets for the given project and location. * - * Method: oracledatabase.projects.locations.dbSystemShapes.list + * Method: oracledatabase.projects.locations.databaseCharacterSets.list * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemShapesList : GTLROracleDatabaseQuery +@interface GTLROracleDatabaseQuery_ProjectsLocationsDatabaseCharacterSetsList : GTLROracleDatabaseQuery /** - * Optional. The maximum number of items to return. If unspecified, at most 50 - * database system shapes will be returned. The maximum value is 1000; values + * Optional. An expression for filtering the results of the request. Only the + * **character_set_type** field is supported in the following format: + * `character_set_type="{characterSetType}"`. Accepted values include + * `DATABASE` and `NATIONAL`. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. The maximum number of DatabaseCharacterSets to return. The service + * may return fewer than this value. If unspecified, at most 50 + * DatabaseCharacterSets will be returned. The maximum value is 1000; values * above 1000 will be coerced to 1000. */ @property(nonatomic, assign) NSInteger pageSize; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A page token, received from a previous `ListDatabaseCharacterSets` + * call. Provide this to retrieve the subsequent page. When paginating, all + * other parameters provided to `ListDatabaseCharacterSets` must match the call + * that provided the page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; /** - * Required. The parent value for Database System Shapes in the following + * Required. The parent value for DatabaseCharacterSets in the following * format: projects/{project}/locations/{location}. */ @property(nonatomic, copy, nullable) NSString *parent; /** - * Fetches a @c GTLROracleDatabase_ListDbSystemShapesResponse. + * Fetches a @c GTLROracleDatabase_ListDatabaseCharacterSetsResponse. * - * Lists the database system shapes available for the project and location. + * List DatabaseCharacterSets for the given project and location. * - * @param parent Required. The parent value for Database System Shapes in the + * @param parent Required. The parent value for DatabaseCharacterSets in the * following format: projects/{project}/locations/{location}. * - * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemShapesList + * @return GTLROracleDatabaseQuery_ProjectsLocationsDatabaseCharacterSetsList * * @note Automatic pagination will be done when @c shouldFetchNextPages is * enabled. See @c shouldFetchNextPages on @c GTLRService for more @@ -1073,121 +1184,82 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Lists the entitlements in a given project. + * Gets details of a single Database. * - * Method: oracledatabase.projects.locations.entitlements.list + * Method: oracledatabase.projects.locations.databases.get * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsEntitlementsList : GTLROracleDatabaseQuery - -/** - * Optional. The maximum number of items to return. If unspecified, a maximum - * of 50 entitlements will be returned. The maximum value is 1000. - */ -@property(nonatomic, assign) NSInteger pageSize; - -/** - * Optional. A token identifying a page of results the server should return. - */ -@property(nonatomic, copy, nullable) NSString *pageToken; - -/** - * Required. The parent value for the entitlement in the following format: - * projects/{project}/locations/{location}. - */ -@property(nonatomic, copy, nullable) NSString *parent; - -/** - * Fetches a @c GTLROracleDatabase_ListEntitlementsResponse. - * - * Lists the entitlements in a given project. - * - * @param parent Required. The parent value for the entitlement in the - * following format: projects/{project}/locations/{location}. - * - * @return GTLROracleDatabaseQuery_ProjectsLocationsEntitlementsList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. - */ -+ (instancetype)queryWithParent:(NSString *)parent; - -@end +@interface GTLROracleDatabaseQuery_ProjectsLocationsDatabasesGet : GTLROracleDatabaseQuery /** - * Gets information about a location. - * - * Method: oracledatabase.projects.locations.get - * - * Authorization scope(s): - * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + * Required. The name of the Database resource in the following format: + * projects/{project}/locations/{region}/databases/{database} */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsGet : GTLROracleDatabaseQuery - -/** Resource name for the location. */ @property(nonatomic, copy, nullable) NSString *name; /** - * Fetches a @c GTLROracleDatabase_Location. + * Fetches a @c GTLROracleDatabase_Database. * - * Gets information about a location. + * Gets details of a single Database. * - * @param name Resource name for the location. + * @param name Required. The name of the Database resource in the following + * format: projects/{project}/locations/{region}/databases/{database} * - * @return GTLROracleDatabaseQuery_ProjectsLocationsGet + * @return GTLROracleDatabaseQuery_ProjectsLocationsDatabasesGet */ + (instancetype)queryWithName:(NSString *)name; @end /** - * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given - * project and location. + * Lists all the Databases for the given project, location and DbSystem. * - * Method: oracledatabase.projects.locations.giVersions.list + * Method: oracledatabase.projects.locations.databases.list * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsList : GTLROracleDatabaseQuery +@interface GTLROracleDatabaseQuery_ProjectsLocationsDatabasesList : GTLROracleDatabaseQuery /** - * Optional. An expression for filtering the results of the request. Only the - * shape and gi_version fields are supported in this format: `shape="{shape}"`. + * Optional. An expression for filtering the results of the request. list for + * container databases is supported only with a valid dbSystem (full resource + * name) filter in this format: + * `dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"` */ @property(nonatomic, copy, nullable) NSString *filter; /** * Optional. The maximum number of items to return. If unspecified, a maximum - * of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum - * value is 1000; values above 1000 will be reset to 1000. + * of 50 System Versions will be returned. The maximum value is 1000; values + * above 1000 will be reset to 1000. */ @property(nonatomic, assign) NSInteger pageSize; /** - * Optional. A token identifying a page of results the server should return. + * Optional. A token identifying the requested page of results to return. All + * fields except the filter should remain the same as in the request that + * provided this page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; /** - * Required. The parent value for Grid Infrastructure Version in the following - * format: Format: projects/{project}/locations/{location}. + * Required. The parent resource name in the following format: + * projects/{project}/locations/{region} */ @property(nonatomic, copy, nullable) NSString *parent; /** - * Fetches a @c GTLROracleDatabase_ListGiVersionsResponse. + * Fetches a @c GTLROracleDatabase_ListDatabasesResponse. * - * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given - * project and location. + * Lists all the Databases for the given project, location and DbSystem. * - * @param parent Required. The parent value for Grid Infrastructure Version in - * the following format: Format: projects/{project}/locations/{location}. + * @param parent Required. The parent resource name in the following format: + * projects/{project}/locations/{region} * - * @return GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsList + * @return GTLROracleDatabaseQuery_ProjectsLocationsDatabasesList * * @note Automatic pagination will be done when @c shouldFetchNextPages is * enabled. See @c shouldFetchNextPages on @c GTLRService for more @@ -1198,90 +1270,89 @@ NS_ASSUME_NONNULL_BEGIN @end /** - * Lists information about the supported locations for this service. + * Lists all the DbSystemInitialStorageSizes for the given project and + * location. * - * Method: oracledatabase.projects.locations.list + * Method: oracledatabase.projects.locations.dbSystemInitialStorageSizes.list * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsList : GTLROracleDatabaseQuery - -/** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. - */ -@property(nonatomic, strong, nullable) NSArray *extraLocationTypes; +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemInitialStorageSizesList : GTLROracleDatabaseQuery /** - * A filter to narrow down results to a preferred subset. The filtering - * language accepts strings like `"displayName=tokyo"`, and is documented in - * more detail in [AIP-160](https://google.aip.dev/160). + * Optional. The maximum number of items to return. If unspecified, a maximum + * of 50 System Versions will be returned. The maximum value is 1000; values + * above 1000 will be reset to 1000. */ -@property(nonatomic, copy, nullable) NSString *filter; - -/** The resource that owns the locations collection, if applicable. */ -@property(nonatomic, copy, nullable) NSString *name; +@property(nonatomic, assign) NSInteger pageSize; /** - * The maximum number of results to return. If not set, the service selects a - * default. + * Optional. A token identifying the requested page of results to return. All + * fields except the filter should remain the same as in the request that + * provided this page token. */ -@property(nonatomic, assign) NSInteger pageSize; +@property(nonatomic, copy, nullable) NSString *pageToken; /** - * A page token received from the `next_page_token` field in the response. Send - * that page token to receive the subsequent page. + * Required. The parent value for the DbSystemInitialStorageSize resource with + * the format: projects/{project}/locations/{location} */ -@property(nonatomic, copy, nullable) NSString *pageToken; +@property(nonatomic, copy, nullable) NSString *parent; /** - * Fetches a @c GTLROracleDatabase_ListLocationsResponse. + * Fetches a @c GTLROracleDatabase_ListDbSystemInitialStorageSizesResponse. * - * Lists information about the supported locations for this service. + * Lists all the DbSystemInitialStorageSizes for the given project and + * location. * - * @param name The resource that owns the locations collection, if applicable. + * @param parent Required. The parent value for the DbSystemInitialStorageSize + * resource with the format: projects/{project}/locations/{location} * - * @return GTLROracleDatabaseQuery_ProjectsLocationsList + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemInitialStorageSizesList * * @note Automatic pagination will be done when @c shouldFetchNextPages is * enabled. See @c shouldFetchNextPages on @c GTLRService for more * information. */ -+ (instancetype)queryWithName:(NSString *)name; ++ (instancetype)queryWithParent:(NSString *)parent; @end /** - * Creates a new ODB Network in a given project and location. + * Creates a new DbSystem in a given project and location. * - * Method: oracledatabase.projects.locations.odbNetworks.create + * Method: oracledatabase.projects.locations.dbSystems.create * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksCreate : GTLROracleDatabaseQuery +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsCreate : GTLROracleDatabaseQuery /** - * Required. The ID of the OdbNetwork to create. This value is restricted to + * Required. The ID of the DbSystem to create. This value is restricted to * (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters * in length. The value must start with a letter and end with a letter or a * number. */ -@property(nonatomic, copy, nullable) NSString *odbNetworkId; +@property(nonatomic, copy, nullable) NSString *dbSystemId; /** - * Required. The parent value for the OdbNetwork in the following format: + * Required. The value for parent of the DbSystem in the following format: * projects/{project}/locations/{location}. */ @property(nonatomic, copy, nullable) NSString *parent; /** - * Optional. An optional ID to identify the request. This value is used to - * identify duplicate requests. If you make a request with the same request ID - * and the original request is still in progress or completed, the server - * ignores the second request. This prevents clients from accidentally creating - * duplicate commitments. The request ID must be a valid UUID with the + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. For example, + * consider a situation where you make an initial request and the request times + * out. If you make the request again with the same request ID, the server can + * check if original operation with the same request ID was received, and if + * so, will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with the * exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). */ @@ -1290,32 +1361,32 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLROracleDatabase_Operation. * - * Creates a new ODB Network in a given project and location. + * Creates a new DbSystem in a given project and location. * - * @param object The @c GTLROracleDatabase_OdbNetwork to include in the query. - * @param parent Required. The parent value for the OdbNetwork in the following - * format: projects/{project}/locations/{location}. + * @param object The @c GTLROracleDatabase_DbSystem to include in the query. + * @param parent Required. The value for parent of the DbSystem in the + * following format: projects/{project}/locations/{location}. * - * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksCreate + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsCreate */ -+ (instancetype)queryWithObject:(GTLROracleDatabase_OdbNetwork *)object ++ (instancetype)queryWithObject:(GTLROracleDatabase_DbSystem *)object parent:(NSString *)parent; @end /** - * Deletes a single ODB Network. + * Deletes a single DbSystem. * - * Method: oracledatabase.projects.locations.odbNetworks.delete + * Method: oracledatabase.projects.locations.dbSystems.delete * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksDelete : GTLROracleDatabaseQuery +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsDelete : GTLROracleDatabaseQuery /** - * Required. The name of the resource in the following format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + * Required. The name of the DbSystem in the following format: + * projects/{project}/locations/{location}/dbSystems/{db_system}. */ @property(nonatomic, copy, nullable) NSString *name; @@ -1333,67 +1404,68 @@ NS_ASSUME_NONNULL_BEGIN /** * Fetches a @c GTLROracleDatabase_Operation. * - * Deletes a single ODB Network. + * Deletes a single DbSystem. * - * @param name Required. The name of the resource in the following format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + * @param name Required. The name of the DbSystem in the following format: + * projects/{project}/locations/{location}/dbSystems/{db_system}. * - * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksDelete + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsDelete */ + (instancetype)queryWithName:(NSString *)name; @end /** - * Gets details of a single ODB Network. + * Gets details of a single DbSystem. * - * Method: oracledatabase.projects.locations.odbNetworks.get + * Method: oracledatabase.projects.locations.dbSystems.get * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksGet : GTLROracleDatabaseQuery +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsGet : GTLROracleDatabaseQuery /** - * Required. The name of the OdbNetwork in the following format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + * Required. The name of the DbSystem in the following format: + * projects/{project}/locations/{location}/dbSystems/{db_system}. */ @property(nonatomic, copy, nullable) NSString *name; /** - * Fetches a @c GTLROracleDatabase_OdbNetwork. + * Fetches a @c GTLROracleDatabase_DbSystem. * - * Gets details of a single ODB Network. + * Gets details of a single DbSystem. * - * @param name Required. The name of the OdbNetwork in the following format: - * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + * @param name Required. The name of the DbSystem in the following format: + * projects/{project}/locations/{location}/dbSystems/{db_system}. * - * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksGet + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsGet */ + (instancetype)queryWithName:(NSString *)name; @end /** - * Lists the ODB Networks in a given project and location. + * Lists the database system shapes available for the project and location. * - * Method: oracledatabase.projects.locations.odbNetworks.list + * Method: oracledatabase.projects.locations.dbSystemShapes.list * * Authorization scope(s): * @c kGTLRAuthScopeOracleDatabaseCloudPlatform */ -@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksList : GTLROracleDatabaseQuery +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemShapesList : GTLROracleDatabaseQuery -/** Optional. An expression for filtering the results of the request. */ +/** + * Optional. An expression for filtering the results of the request. Only the + * gcp_oracle_zone_id field is supported in this format: + * `gcp_oracle_zone_id="{gcp_oracle_zone_id}"`. + */ @property(nonatomic, copy, nullable) NSString *filter; -/** Optional. An expression for ordering the results of the request. */ -@property(nonatomic, copy, nullable) NSString *orderBy; - /** * Optional. The maximum number of items to return. If unspecified, at most 50 - * ODB Networks will be returned. The maximum value is 1000; values above 1000 - * will be coerced to 1000. + * database system shapes will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. */ @property(nonatomic, assign) NSInteger pageSize; @@ -1403,17 +1475,1000 @@ NS_ASSUME_NONNULL_BEGIN @property(nonatomic, copy, nullable) NSString *pageToken; /** - * Required. The parent value for the ODB Network in the following format: - * projects/{project}/locations/{location}. + * Required. The parent value for Database System Shapes in the following + * format: projects/{project}/locations/{location}. */ @property(nonatomic, copy, nullable) NSString *parent; /** - * Fetches a @c GTLROracleDatabase_ListOdbNetworksResponse. + * Fetches a @c GTLROracleDatabase_ListDbSystemShapesResponse. * - * Lists the ODB Networks in a given project and location. + * Lists the database system shapes available for the project and location. * - * @param parent Required. The parent value for the ODB Network in the + * @param parent Required. The parent value for Database System Shapes in the + * following format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemShapesList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Lists all the DbSystems for the given project and location. + * + * Method: oracledatabase.projects.locations.dbSystems.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsList : GTLROracleDatabaseQuery + +/** Optional. An expression for filtering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** Optional. An expression for ordering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Optional. The maximum number of items to return. If unspecified, at most 50 + * DbSystems will be returned. The maximum value is 1000; values above 1000 + * will be coerced to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying a page of results the server should return. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for DbSystems in the following format: + * projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListDbSystemsResponse. + * + * Lists all the DbSystems for the given project and location. + * + * @param parent Required. The parent value for DbSystems in the following + * format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbSystemsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * List DbVersions for the given project and location. + * + * Method: oracledatabase.projects.locations.dbVersions.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsDbVersionsList : GTLROracleDatabaseQuery + +/** + * Optional. Filter expression that matches a subset of the DbVersions to show. + * The supported filter for dbSystem creation is `db_system_shape = + * {db_system_shape} AND storage_management = {storage_management}`. If no + * filter is provided, all DbVersions will be returned. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. The maximum number of items to return. If unspecified, a maximum + * of 50 System Versions will be returned. The maximum value is 1000; values + * above 1000 will be reset to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying the requested page of results to return. All + * fields except the filter should remain the same as in the request that + * provided this page token. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for the DbVersion resource with the format: + * projects/{project}/locations/{location} + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListDbVersionsResponse. + * + * List DbVersions for the given project and location. + * + * @param parent Required. The parent value for the DbVersion resource with the + * format: projects/{project}/locations/{location} + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsDbVersionsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Lists the entitlements in a given project. + * + * Method: oracledatabase.projects.locations.entitlements.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsEntitlementsList : GTLROracleDatabaseQuery + +/** + * Optional. The maximum number of items to return. If unspecified, a maximum + * of 50 entitlements will be returned. The maximum value is 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying a page of results the server should return. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for the entitlement in the following format: + * projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListEntitlementsResponse. + * + * Lists the entitlements in a given project. + * + * @param parent Required. The parent value for the entitlement in the + * following format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsEntitlementsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Creates a new Exadb (Exascale) VM Cluster resource. + * + * Method: oracledatabase.projects.locations.exadbVmClusters.create + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersCreate : GTLROracleDatabaseQuery + +/** + * Required. The ID of the ExadbVmCluster to create. This value is restricted + * to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 + * characters in length. The value must start with a letter and end with a + * letter or a number. + */ +@property(nonatomic, copy, nullable) NSString *exadbVmClusterId; + +/** + * Required. The value for parent of the ExadbVmCluster in the following + * format: projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. For example, + * consider a situation where you make an initial request and the request times + * out. If you make the request again with the same request ID, the server can + * check if original operation with the same request ID was received, and if + * so, will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Creates a new Exadb (Exascale) VM Cluster resource. + * + * @param object The @c GTLROracleDatabase_ExadbVmCluster to include in the + * query. + * @param parent Required. The value for parent of the ExadbVmCluster in the + * following format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersCreate + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_ExadbVmCluster *)object + parent:(NSString *)parent; + +@end + +/** + * Deletes a single Exadb (Exascale) VM Cluster. + * + * Method: oracledatabase.projects.locations.exadbVmClusters.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersDelete : GTLROracleDatabaseQuery + +/** + * Required. The name of the ExadbVmCluster in the following format: + * projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Deletes a single Exadb (Exascale) VM Cluster. + * + * @param name Required. The name of the ExadbVmCluster in the following + * format: + * projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersDelete + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Gets details of a single Exadb (Exascale) VM Cluster. + * + * Method: oracledatabase.projects.locations.exadbVmClusters.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersGet : GTLROracleDatabaseQuery + +/** + * Required. The name of the ExadbVmCluster in the following format: + * projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_ExadbVmCluster. + * + * Gets details of a single Exadb (Exascale) VM Cluster. + * + * @param name Required. The name of the ExadbVmCluster in the following + * format: + * projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Lists all the Exadb (Exascale) VM Clusters for the given project and + * location. + * + * Method: oracledatabase.projects.locations.exadbVmClusters.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersList : GTLROracleDatabaseQuery + +/** Optional. An expression for filtering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** Optional. An expression for ordering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Optional. The maximum number of items to return. If unspecified, at most 50 + * ExadbVmClusters will be returned. The maximum value is 1000; values above + * 1000 will be coerced to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying a page of results the server should return. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for ExadbVmClusters in the following format: + * projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListExadbVmClustersResponse. + * + * Lists all the Exadb (Exascale) VM Clusters for the given project and + * location. + * + * @param parent Required. The parent value for ExadbVmClusters in the + * following format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to + * existing exadb vm cluster, only pass the node count. + * + * Method: oracledatabase.projects.locations.exadbVmClusters.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersPatch : GTLROracleDatabaseQuery + +/** + * Identifier. The name of the ExadbVmCluster resource in the following format: + * projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Optional. A mask specifying which fields in th VM Cluster should be updated. + * A field specified in the mask is overwritten. If a mask isn't provided then + * all the fields in the VM Cluster are overwritten. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to + * existing exadb vm cluster, only pass the node count. + * + * @param object The @c GTLROracleDatabase_ExadbVmCluster to include in the + * query. + * @param name Identifier. The name of the ExadbVmCluster resource in the + * following format: + * projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster} + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersPatch + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_ExadbVmCluster *)object + name:(NSString *)name; + +@end + +/** + * Removes virtual machines from an existing exadb vm cluster. + * + * Method: oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersRemoveVirtualMachine : GTLROracleDatabaseQuery + +/** + * Required. The name of the ExadbVmCluster in the following format: + * projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Removes virtual machines from an existing exadb vm cluster. + * + * @param object The @c + * GTLROracleDatabase_RemoveVirtualMachineExadbVmClusterRequest to include in + * the query. + * @param name Required. The name of the ExadbVmCluster in the following + * format: + * projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExadbVmClustersRemoveVirtualMachine + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_RemoveVirtualMachineExadbVmClusterRequest *)object + name:(NSString *)name; + +@end + +/** + * Creates a new ExascaleDB Storage Vault resource. + * + * Method: oracledatabase.projects.locations.exascaleDbStorageVaults.create + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsCreate : GTLROracleDatabaseQuery + +/** + * Required. The ID of the ExascaleDbStorageVault to create. This value is + * restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of + * 63 characters in length. The value must start with a letter and end with a + * letter or a number. + */ +@property(nonatomic, copy, nullable) NSString *exascaleDbStorageVaultId; + +/** + * Required. The value for parent of the ExascaleDbStorageVault in the + * following format: projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. For example, + * consider a situation where you make an initial request and the request times + * out. If you make the request again with the same request ID, the server can + * check if original operation with the same request ID was received, and if + * so, will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Creates a new ExascaleDB Storage Vault resource. + * + * @param object The @c GTLROracleDatabase_ExascaleDbStorageVault to include in + * the query. + * @param parent Required. The value for parent of the ExascaleDbStorageVault + * in the following format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsCreate + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_ExascaleDbStorageVault *)object + parent:(NSString *)parent; + +@end + +/** + * Deletes a single ExascaleDB Storage Vault. + * + * Method: oracledatabase.projects.locations.exascaleDbStorageVaults.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsDelete : GTLROracleDatabaseQuery + +/** + * Required. The name of the ExascaleDbStorageVault in the following format: + * projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Deletes a single ExascaleDB Storage Vault. + * + * @param name Required. The name of the ExascaleDbStorageVault in the + * following format: + * projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsDelete + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Gets details of a single ExascaleDB Storage Vault. + * + * Method: oracledatabase.projects.locations.exascaleDbStorageVaults.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsGet : GTLROracleDatabaseQuery + +/** + * Required. The name of the ExascaleDbStorageVault in the following format: + * projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_ExascaleDbStorageVault. + * + * Gets details of a single ExascaleDB Storage Vault. + * + * @param name Required. The name of the ExascaleDbStorageVault in the + * following format: + * projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Lists all the ExascaleDB Storage Vaults for the given project and location. + * + * Method: oracledatabase.projects.locations.exascaleDbStorageVaults.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsList : GTLROracleDatabaseQuery + +/** + * Optional. An expression for filtering the results of the request. Filter the + * list as specified in https://google.aip.dev/160. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. An expression for ordering the results of the request. Order + * results as specified in https://google.aip.dev/132. + */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Optional. The maximum number of items to return. If unspecified, at most 50 + * ExascaleDbStorageVaults will be returned. The maximum value is 1000; values + * above 1000 will be coerced to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying a page of results the server should return. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for ExascaleDbStorageVault in the following + * format: projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListExascaleDbStorageVaultsResponse. + * + * Lists all the ExascaleDB Storage Vaults for the given project and location. + * + * @param parent Required. The parent value for ExascaleDbStorageVault in the + * following format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsExascaleDbStorageVaultsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Gets information about a location. + * + * Method: oracledatabase.projects.locations.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsGet : GTLROracleDatabaseQuery + +/** Resource name for the location. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_Location. + * + * Gets information about a location. + * + * @param name Resource name for the location. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given + * project and location. + * + * Method: oracledatabase.projects.locations.giVersions.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsList : GTLROracleDatabaseQuery + +/** + * Optional. An expression for filtering the results of the request. Only the + * shape, gcp_oracle_zone and gi_version fields are supported in this format: + * `shape="{shape}"`. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. The maximum number of items to return. If unspecified, a maximum + * of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum + * value is 1000; values above 1000 will be reset to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying a page of results the server should return. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for Grid Infrastructure Version in the following + * format: Format: projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListGiVersionsResponse. + * + * Lists all the valid Oracle Grid Infrastructure (GI) versions for the given + * project and location. + * + * @param parent Required. The parent value for Grid Infrastructure Version in + * the following format: Format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Lists all the valid minor versions for the given project, location, gi + * version and shape family. + * + * Method: oracledatabase.projects.locations.giVersions.minorVersions.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsMinorVersionsList : GTLROracleDatabaseQuery + +/** + * Optional. An expression for filtering the results of the request. Only + * shapeFamily and gcp_oracle_zone_id are supported in this format: + * `shape_family="{shapeFamily}" AND + * gcp_oracle_zone_id="{gcp_oracle_zone_id}"`. + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. The maximum number of items to return. If unspecified, a maximum + * of 50 System Versions will be returned. The maximum value is 1000; values + * above 1000 will be reset to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying the requested page of results to return. All + * fields except the filter should remain the same as in the request that + * provided this page token. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for the MinorVersion resource with the format: + * projects/{project}/locations/{location}/giVersions/{gi_version} + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListMinorVersionsResponse. + * + * Lists all the valid minor versions for the given project, location, gi + * version and shape family. + * + * @param parent Required. The parent value for the MinorVersion resource with + * the format: + * projects/{project}/locations/{location}/giVersions/{gi_version} + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsGiVersionsMinorVersionsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Lists information about the supported locations for this service. + * + * Method: oracledatabase.projects.locations.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsList : GTLROracleDatabaseQuery + +/** + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. + */ +@property(nonatomic, strong, nullable) NSArray *extraLocationTypes; + +/** + * A filter to narrow down results to a preferred subset. The filtering + * language accepts strings like `"displayName=tokyo"`, and is documented in + * more detail in [AIP-160](https://google.aip.dev/160). + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** The resource that owns the locations collection, if applicable. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * The maximum number of results to return. If not set, the service selects a + * default. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * A page token received from the `next_page_token` field in the response. Send + * that page token to receive the subsequent page. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Fetches a @c GTLROracleDatabase_ListLocationsResponse. + * + * Lists information about the supported locations for this service. + * + * @param name The resource that owns the locations collection, if applicable. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Creates a new ODB Network in a given project and location. + * + * Method: oracledatabase.projects.locations.odbNetworks.create + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksCreate : GTLROracleDatabaseQuery + +/** + * Required. The ID of the OdbNetwork to create. This value is restricted to + * (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters + * in length. The value must start with a letter and end with a letter or a + * number. + */ +@property(nonatomic, copy, nullable) NSString *odbNetworkId; + +/** + * Required. The parent value for the OdbNetwork in the following format: + * projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Creates a new ODB Network in a given project and location. + * + * @param object The @c GTLROracleDatabase_OdbNetwork to include in the query. + * @param parent Required. The parent value for the OdbNetwork in the following + * format: projects/{project}/locations/{location}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksCreate + */ ++ (instancetype)queryWithObject:(GTLROracleDatabase_OdbNetwork *)object + parent:(NSString *)parent; + +@end + +/** + * Deletes a single ODB Network. + * + * Method: oracledatabase.projects.locations.odbNetworks.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksDelete : GTLROracleDatabaseQuery + +/** + * Required. The name of the resource in the following format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. An optional ID to identify the request. This value is used to + * identify duplicate requests. If you make a request with the same request ID + * and the original request is still in progress or completed, the server + * ignores the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Fetches a @c GTLROracleDatabase_Operation. + * + * Deletes a single ODB Network. + * + * @param name Required. The name of the resource in the following format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksDelete + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Gets details of a single ODB Network. + * + * Method: oracledatabase.projects.locations.odbNetworks.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksGet : GTLROracleDatabaseQuery + +/** + * Required. The name of the OdbNetwork in the following format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_OdbNetwork. + * + * Gets details of a single ODB Network. + * + * @param name Required. The name of the OdbNetwork in the following format: + * projects/{project}/locations/{location}/odbNetworks/{odb_network}. + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Lists the ODB Networks in a given project and location. + * + * Method: oracledatabase.projects.locations.odbNetworks.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksList : GTLROracleDatabaseQuery + +/** Optional. An expression for filtering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** Optional. An expression for ordering the results of the request. */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** + * Optional. The maximum number of items to return. If unspecified, at most 50 + * ODB Networks will be returned. The maximum value is 1000; values above 1000 + * will be coerced to 1000. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A token identifying a page of results the server should return. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent value for the ODB Network in the following format: + * projects/{project}/locations/{location}. + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListOdbNetworksResponse. + * + * Lists the ODB Networks in a given project and location. + * + * @param parent Required. The parent value for the ODB Network in the * following format: projects/{project}/locations/{location}. * * @return GTLROracleDatabaseQuery_ProjectsLocationsOdbNetworksList @@ -1730,6 +2785,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLROracleDatabase_ListOperationsResponse. * @@ -1748,6 +2814,96 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Gets details of a single PluggableDatabase. + * + * Method: oracledatabase.projects.locations.pluggableDatabases.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesGet : GTLROracleDatabaseQuery + +/** + * Required. The name of the PluggableDatabase resource in the following + * format: + * projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database} + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLROracleDatabase_PluggableDatabase. + * + * Gets details of a single PluggableDatabase. + * + * @param name Required. The name of the PluggableDatabase resource in the + * following format: + * projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database} + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Lists all the PluggableDatabases for the given project, location and + * Container Database. + * + * Method: oracledatabase.projects.locations.pluggableDatabases.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeOracleDatabaseCloudPlatform + */ +@interface GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesList : GTLROracleDatabaseQuery + +/** + * Optional. An expression for filtering the results of the request. List for + * pluggable databases is supported only with a valid container database (full + * resource name) filter in this format: + * `database="projects/{project}/locations/{location}/databases/{database}"` + */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** + * Optional. The maximum number of PluggableDatabases to return. The service + * may return fewer than this value. + */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * Optional. A page token, received from a previous `ListPluggableDatabases` + * call. Provide this to retrieve the subsequent page. When paginating, all + * other parameters provided to `ListPluggableDatabases` must match the call + * that provided the page token. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** + * Required. The parent, which owns this collection of PluggableDatabases. + * Format: projects/{project}/locations/{location} + */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLROracleDatabase_ListPluggableDatabasesResponse. + * + * Lists all the PluggableDatabases for the given project, location and + * Container Database. + * + * @param parent Required. The parent, which owns this collection of + * PluggableDatabases. Format: projects/{project}/locations/{location} + * + * @return GTLROracleDatabaseQuery_ProjectsLocationsPluggableDatabasesList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + NS_ASSUME_NONNULL_END #pragma clang diagnostic pop diff --git a/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreObjects.m b/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreObjects.m index 9492ed4cf..9b498776a 100644 --- a/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreObjects.m +++ b/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreObjects.m @@ -207,11 +207,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRParallelstore_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRParallelstore_Operation class] + @"operations" : [GTLRParallelstore_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreQuery.m b/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreQuery.m index b9ac6dfc9..f37cc782c 100644 --- a/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreQuery.m +++ b/Sources/GeneratedServices/Parallelstore/GTLRParallelstoreQuery.m @@ -291,7 +291,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRParallelstoreQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreObjects.h b/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreObjects.h index 768434b62..64df1cd4e 100644 --- a/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreObjects.h +++ b/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreObjects.h @@ -633,6 +633,13 @@ FOUNDATION_EXTERN NSString * const kGTLRParallelstore_TransferMetadataOptions_Ui */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreQuery.h b/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreQuery.h index 005fda40b..4a7da4339 100644 --- a/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreQuery.h +++ b/Sources/GeneratedServices/Parallelstore/Public/GoogleAPIClientForREST/GTLRParallelstoreQuery.h @@ -366,8 +366,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRParallelstoreQuery_ProjectsLocationsList : GTLRParallelstoreQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -540,6 +540,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRParallelstore_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/ParameterManager/Public/GoogleAPIClientForREST/GTLRParameterManagerQuery.h b/Sources/GeneratedServices/ParameterManager/Public/GoogleAPIClientForREST/GTLRParameterManagerQuery.h index ab4b621d5..4b4987ef3 100644 --- a/Sources/GeneratedServices/ParameterManager/Public/GoogleAPIClientForREST/GTLRParameterManagerQuery.h +++ b/Sources/GeneratedServices/ParameterManager/Public/GoogleAPIClientForREST/GTLRParameterManagerQuery.h @@ -103,8 +103,8 @@ FOUNDATION_EXTERN NSString * const kGTLRParameterManagerViewViewUnspecified; @interface GTLRParameterManagerQuery_ProjectsLocationsList : GTLRParameterManagerQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/PaymentsResellerSubscription/GTLRPaymentsResellerSubscriptionObjects.m b/Sources/GeneratedServices/PaymentsResellerSubscription/GTLRPaymentsResellerSubscriptionObjects.m index 735dd7f7f..f6ec2f16e 100644 --- a/Sources/GeneratedServices/PaymentsResellerSubscription/GTLRPaymentsResellerSubscriptionObjects.m +++ b/Sources/GeneratedServices/PaymentsResellerSubscription/GTLRPaymentsResellerSubscriptionObjects.m @@ -14,6 +14,7 @@ // GTLRPaymentsResellerSubscription_CancelSubscriptionRequest.cancellationReason NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonAccidentalPurchase = @"CANCELLATION_REASON_ACCIDENTAL_PURCHASE"; NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonAccountClosed = @"CANCELLATION_REASON_ACCOUNT_CLOSED"; +NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonBillingSystemSwitch = @"CANCELLATION_REASON_BILLING_SYSTEM_SWITCH"; NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonFraud = @"CANCELLATION_REASON_FRAUD"; NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonOther = @"CANCELLATION_REASON_OTHER"; NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonPastDue = @"CANCELLATION_REASON_PAST_DUE"; @@ -76,6 +77,7 @@ // GTLRPaymentsResellerSubscription_SubscriptionCancellationDetails.reason NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonAccidentalPurchase = @"CANCELLATION_REASON_ACCIDENTAL_PURCHASE"; NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonAccountClosed = @"CANCELLATION_REASON_ACCOUNT_CLOSED"; +NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonBillingSystemSwitch = @"CANCELLATION_REASON_BILLING_SYSTEM_SWITCH"; NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonFraud = @"CANCELLATION_REASON_FRAUD"; NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonOther = @"CANCELLATION_REASON_OTHER"; NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonPastDue = @"CANCELLATION_REASON_PAST_DUE"; diff --git a/Sources/GeneratedServices/PaymentsResellerSubscription/Public/GoogleAPIClientForREST/GTLRPaymentsResellerSubscriptionObjects.h b/Sources/GeneratedServices/PaymentsResellerSubscription/Public/GoogleAPIClientForREST/GTLRPaymentsResellerSubscriptionObjects.h index 64930bc32..5755bee02 100644 --- a/Sources/GeneratedServices/PaymentsResellerSubscription/Public/GoogleAPIClientForREST/GTLRPaymentsResellerSubscriptionObjects.h +++ b/Sources/GeneratedServices/PaymentsResellerSubscription/Public/GoogleAPIClientForREST/GTLRPaymentsResellerSubscriptionObjects.h @@ -70,6 +70,12 @@ FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_CancelSubsc * Value: "CANCELLATION_REASON_ACCOUNT_CLOSED" */ FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonAccountClosed; +/** + * Cancellation due to a billing system switch. + * + * Value: "CANCELLATION_REASON_BILLING_SYSTEM_SWITCH" + */ +FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonBillingSystemSwitch; /** * Fraudualant transaction. * @@ -383,6 +389,12 @@ FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_Subscriptio * Value: "CANCELLATION_REASON_ACCOUNT_CLOSED" */ FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonAccountClosed; +/** + * Cancellation due to a billing system switch. + * + * Value: "CANCELLATION_REASON_BILLING_SYSTEM_SWITCH" + */ +FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonBillingSystemSwitch; /** * Fraudualant transaction. * @@ -653,6 +665,9 @@ FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_YoutubePayl * @arg @c kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonAccountClosed * Used for notification only, do not use in Cancel API. User account * closed. (Value: "CANCELLATION_REASON_ACCOUNT_CLOSED") + * @arg @c kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonBillingSystemSwitch + * Cancellation due to a billing system switch. (Value: + * "CANCELLATION_REASON_BILLING_SYSTEM_SWITCH") * @arg @c kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonFraud * Fraudualant transaction. (Value: "CANCELLATION_REASON_FRAUD") * @arg @c kGTLRPaymentsResellerSubscription_CancelSubscriptionRequest_CancellationReason_CancellationReasonOther @@ -1651,6 +1666,9 @@ FOUNDATION_EXTERN NSString * const kGTLRPaymentsResellerSubscription_YoutubePayl * @arg @c kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonAccountClosed * Used for notification only, do not use in Cancel API. User account * closed. (Value: "CANCELLATION_REASON_ACCOUNT_CLOSED") + * @arg @c kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonBillingSystemSwitch + * Cancellation due to a billing system switch. (Value: + * "CANCELLATION_REASON_BILLING_SYSTEM_SWITCH") * @arg @c kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonFraud * Fraudualant transaction. (Value: "CANCELLATION_REASON_FRAUD") * @arg @c kGTLRPaymentsResellerSubscription_SubscriptionCancellationDetails_Reason_CancellationReasonOther diff --git a/Sources/GeneratedServices/RecaptchaEnterprise/GTLRRecaptchaEnterpriseObjects.m b/Sources/GeneratedServices/RecaptchaEnterprise/GTLRRecaptchaEnterpriseObjects.m index 1b181dd3c..3c5d5d822 100644 --- a/Sources/GeneratedServices/RecaptchaEnterprise/GTLRRecaptchaEnterpriseObjects.m +++ b/Sources/GeneratedServices/RecaptchaEnterprise/GTLRRecaptchaEnterpriseObjects.m @@ -248,7 +248,8 @@ @implementation GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1AndroidK // @implementation GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest -@dynamic accountId, annotation, hashedAccountId, reasons, transactionEvent; +@dynamic accountId, annotation, hashedAccountId, phoneAuthenticationEvent, + reasons, transactionEvent; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -749,6 +750,16 @@ @implementation GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1MigrateK @end +// ---------------------------------------------------------------------------- +// +// GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent +// + +@implementation GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent +@dynamic eventTime, phoneNumber; +@end + + // ---------------------------------------------------------------------------- // // GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment diff --git a/Sources/GeneratedServices/RecaptchaEnterprise/Public/GoogleAPIClientForREST/GTLRRecaptchaEnterpriseObjects.h b/Sources/GeneratedServices/RecaptchaEnterprise/Public/GoogleAPIClientForREST/GTLRRecaptchaEnterpriseObjects.h index 5d3a624c4..c347f5213 100644 --- a/Sources/GeneratedServices/RecaptchaEnterprise/Public/GoogleAPIClientForREST/GTLRRecaptchaEnterpriseObjects.h +++ b/Sources/GeneratedServices/RecaptchaEnterprise/Public/GoogleAPIClientForREST/GTLRRecaptchaEnterpriseObjects.h @@ -46,6 +46,7 @@ @class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1IpOverrideData; @class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1Key; @class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1Key_Labels; +@class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent; @class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment; @class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification; @class GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup; @@ -1121,6 +1122,12 @@ FOUNDATION_EXTERN NSString * const kGTLRRecaptchaEnterprise_GoogleCloudRecaptcha */ @property(nonatomic, copy, nullable) NSString *hashedAccountId; +/** + * Optional. If using an external multi-factor authentication provider, provide + * phone authentication details for fraud detection purposes. + */ +@property(nonatomic, strong, nullable) GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent *phoneAuthenticationEvent; + /** Optional. Reasons for the annotation that are assigned to the event. */ @property(nonatomic, strong, nullable) NSArray *reasons; @@ -2158,6 +2165,26 @@ FOUNDATION_EXTERN NSString * const kGTLRRecaptchaEnterprise_GoogleCloudRecaptcha @end +/** + * Details on a phone authentication event + */ +@interface GTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent : GTLRObject + +/** + * Optional. The time at which the multi-factor authentication event (challenge + * or verification) occurred. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *eventTime; + +/** + * Required. Phone number in E.164 format for which a multi-factor + * authentication challenge was initiated, succeeded, or failed. + */ +@property(nonatomic, copy, nullable) NSString *phoneNumber; + +@end + + /** * Assessment for Phone Fraud */ @@ -2326,7 +2353,7 @@ FOUNDATION_EXTERN NSString * const kGTLRRecaptchaEnterprise_GoogleCloudRecaptcha /** * Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE - * keys + * keys. * * Likely values: * @arg @c kGTLRRecaptchaEnterprise_GoogleCloudRecaptchaenterpriseV1RiskAnalysis_Challenge_ChallengeUnspecified diff --git a/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminObjects.m b/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminObjects.m index ccd8895b7..d8bf95538 100644 --- a/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminObjects.m +++ b/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminObjects.m @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import @@ -61,6 +61,7 @@ NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres15 = @"POSTGRES_15"; NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres16 = @"POSTGRES_16"; NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres17 = @"POSTGRES_17"; +NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres18 = @"POSTGRES_18"; NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres96 = @"POSTGRES_9_6"; NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_SqlDatabaseVersionUnspecified = @"SQL_DATABASE_VERSION_UNSPECIFIED"; NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Sqlserver2017Enterprise = @"SQLSERVER_2017_ENTERPRISE"; @@ -154,6 +155,7 @@ NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres15 = @"POSTGRES_15"; NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres16 = @"POSTGRES_16"; NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres17 = @"POSTGRES_17"; +NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres18 = @"POSTGRES_18"; NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres96 = @"POSTGRES_9_6"; NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_SqlDatabaseVersionUnspecified = @"SQL_DATABASE_VERSION_UNSPECIFIED"; NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Sqlserver2017Enterprise = @"SQLSERVER_2017_ENTERPRISE"; @@ -228,6 +230,7 @@ NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres15 = @"POSTGRES_15"; NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres16 = @"POSTGRES_16"; NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres17 = @"POSTGRES_17"; +NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres18 = @"POSTGRES_18"; NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres96 = @"POSTGRES_9_6"; NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_SqlDatabaseVersionUnspecified = @"SQL_DATABASE_VERSION_UNSPECIFIED"; NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Sqlserver2017Enterprise = @"SQLSERVER_2017_ENTERPRISE"; @@ -295,6 +298,7 @@ NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres15 = @"POSTGRES_15"; NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres16 = @"POSTGRES_16"; NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres17 = @"POSTGRES_17"; +NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres18 = @"POSTGRES_18"; NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres96 = @"POSTGRES_9_6"; NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_SqlDatabaseVersionUnspecified = @"SQL_DATABASE_VERSION_UNSPECIFIED"; NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Sqlserver2017Enterprise = @"SQLSERVER_2017_ENTERPRISE"; @@ -404,6 +408,7 @@ NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres15 = @"POSTGRES_15"; NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres16 = @"POSTGRES_16"; NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres17 = @"POSTGRES_17"; +NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres18 = @"POSTGRES_18"; NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres96 = @"POSTGRES_9_6"; NSString * const kGTLRSQLAdmin_Flag_AppliesTo_SqlDatabaseVersionUnspecified = @"SQL_DATABASE_VERSION_UNSPECIFIED"; NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Sqlserver2017Enterprise = @"SQLSERVER_2017_ENTERPRISE"; @@ -553,6 +558,64 @@ NSString * const kGTLRSQLAdmin_PoolNodeConfig_State_SqlInstanceStateUnspecified = @"SQL_INSTANCE_STATE_UNSPECIFIED"; NSString * const kGTLRSQLAdmin_PoolNodeConfig_State_Suspended = @"SUSPENDED"; +// GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext.targetDatabaseVersion +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql51 = @"MYSQL_5_1"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql55 = @"MYSQL_5_5"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql56 = @"MYSQL_5_6"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql57 = @"MYSQL_5_7"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql80 = @"MYSQL_8_0"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8018 = @"MYSQL_8_0_18"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8026 = @"MYSQL_8_0_26"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8027 = @"MYSQL_8_0_27"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8028 = @"MYSQL_8_0_28"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8029 = @"MYSQL_8_0_29"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8030 = @"MYSQL_8_0_30"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8031 = @"MYSQL_8_0_31"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8032 = @"MYSQL_8_0_32"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8033 = @"MYSQL_8_0_33"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8034 = @"MYSQL_8_0_34"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8035 = @"MYSQL_8_0_35"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8036 = @"MYSQL_8_0_36"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8037 = @"MYSQL_8_0_37"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8039 = @"MYSQL_8_0_39"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8040 = @"MYSQL_8_0_40"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8041 = @"MYSQL_8_0_41"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8042 = @"MYSQL_8_0_42"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8043 = @"MYSQL_8_0_43"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8044 = @"MYSQL_8_0_44"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8045 = @"MYSQL_8_0_45"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8046 = @"MYSQL_8_0_46"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql84 = @"MYSQL_8_4"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres10 = @"POSTGRES_10"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres11 = @"POSTGRES_11"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres12 = @"POSTGRES_12"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres13 = @"POSTGRES_13"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres14 = @"POSTGRES_14"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres15 = @"POSTGRES_15"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres16 = @"POSTGRES_16"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres17 = @"POSTGRES_17"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres18 = @"POSTGRES_18"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres96 = @"POSTGRES_9_6"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_SqlDatabaseVersionUnspecified = @"SQL_DATABASE_VERSION_UNSPECIFIED"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Enterprise = @"SQLSERVER_2017_ENTERPRISE"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Express = @"SQLSERVER_2017_EXPRESS"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Standard = @"SQLSERVER_2017_STANDARD"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Web = @"SQLSERVER_2017_WEB"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Enterprise = @"SQLSERVER_2019_ENTERPRISE"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Express = @"SQLSERVER_2019_EXPRESS"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Standard = @"SQLSERVER_2019_STANDARD"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Web = @"SQLSERVER_2019_WEB"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Enterprise = @"SQLSERVER_2022_ENTERPRISE"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Express = @"SQLSERVER_2022_EXPRESS"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Standard = @"SQLSERVER_2022_STANDARD"; +NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Web = @"SQLSERVER_2022_WEB"; + +// GTLRSQLAdmin_PreCheckResponse.messageType +NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_Error = @"ERROR"; +NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_Info = @"INFO"; +NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_MessageTypeUnspecified = @"MESSAGE_TYPE_UNSPECIFIED"; +NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_Warning = @"WARNING"; + // GTLRSQLAdmin_Reschedule.rescheduleType NSString * const kGTLRSQLAdmin_Reschedule_RescheduleType_Immediate = @"IMMEDIATE"; NSString * const kGTLRSQLAdmin_Reschedule_RescheduleType_NextAvailableWindow = @"NEXT_AVAILABLE_WINDOW"; @@ -630,6 +693,7 @@ NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_MysqlParallelImportInsufficientPrivilege = @"MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE"; NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_NoPglogicalInstalled = @"NO_PGLOGICAL_INSTALLED"; NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgCronFlagEnabledInReplica = @"PG_CRON_FLAG_ENABLED_IN_REPLICA"; +NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgDdlReplicationInsufficientPrivilege = @"PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE"; NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PglogicalNodeAlreadyExists = @"PGLOGICAL_NODE_ALREADY_EXISTS"; NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgSubscriptionCount = @"PG_SUBSCRIPTION_COUNT"; NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgSyncParallelLevel = @"PG_SYNC_PARALLEL_LEVEL"; @@ -712,6 +776,11 @@ NSString * const kGTLRSQLAdmin_User_DualPasswordType_NoDualPassword = @"NO_DUAL_PASSWORD"; NSString * const kGTLRSQLAdmin_User_DualPasswordType_NoModifyDualPassword = @"NO_MODIFY_DUAL_PASSWORD"; +// GTLRSQLAdmin_User.iamStatus +NSString * const kGTLRSQLAdmin_User_IamStatus_Active = @"ACTIVE"; +NSString * const kGTLRSQLAdmin_User_IamStatus_IamStatusUnspecified = @"IAM_STATUS_UNSPECIFIED"; +NSString * const kGTLRSQLAdmin_User_IamStatus_Inactive = @"INACTIVE"; + // GTLRSQLAdmin_User.type NSString * const kGTLRSQLAdmin_User_Type_BuiltIn = @"BUILT_IN"; NSString * const kGTLRSQLAdmin_User_Type_CloudIamGroup = @"CLOUD_IAM_GROUP"; @@ -1799,6 +1868,16 @@ + (BOOL)isKindValidForClassRegistry { @end +// ---------------------------------------------------------------------------- +// +// GTLRSQLAdmin_InstancesPreCheckMajorVersionUpgradeRequest +// + +@implementation GTLRSQLAdmin_InstancesPreCheckMajorVersionUpgradeRequest +@dynamic preCheckMajorVersionUpgradeContext; +@end + + // ---------------------------------------------------------------------------- // // GTLRSQLAdmin_InstancesReencryptRequest @@ -1956,6 +2035,16 @@ + (BOOL)isKindValidForClassRegistry { @end +// ---------------------------------------------------------------------------- +// +// GTLRSQLAdmin_Message +// + +@implementation GTLRSQLAdmin_Message +@dynamic message, severity; +@end + + // ---------------------------------------------------------------------------- // // GTLRSQLAdmin_Metadata @@ -2036,8 +2125,8 @@ + (BOOL)isKindValidForClassRegistry { @implementation GTLRSQLAdmin_Operation @dynamic acquireSsrsLeaseContext, apiWarning, backupContext, endTime, error, exportContext, importContext, insertTime, kind, name, operationType, - selfLink, startTime, status, subOperationType, targetId, targetLink, - targetProject, user; + preCheckMajorVersionUpgradeContext, selfLink, startTime, status, + subOperationType, targetId, targetLink, targetProject, user; + (BOOL)isKindValidForClassRegistry { // This class has a "kind" property that doesn't appear to be usable to @@ -2185,6 +2274,48 @@ @implementation GTLRSQLAdmin_PoolNodeConfig @end +// ---------------------------------------------------------------------------- +// +// GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext +// + +@implementation GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext +@dynamic kind, preCheckResponse, targetDatabaseVersion; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"preCheckResponse" : [GTLRSQLAdmin_PreCheckResponse class] + }; + return map; +} + ++ (BOOL)isKindValidForClassRegistry { + // This class has a "kind" property that doesn't appear to be usable to + // determine what type of object was encoded in the JSON. + return NO; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSQLAdmin_PreCheckResponse +// + +@implementation GTLRSQLAdmin_PreCheckResponse +@dynamic actionsRequired, message, messageType; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"actionsRequired" : [NSString class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRSQLAdmin_PscAutoConnectionConfig @@ -2235,6 +2366,25 @@ @implementation GTLRSQLAdmin_QueryResult @end +// ---------------------------------------------------------------------------- +// +// GTLRSQLAdmin_ReadPoolAutoScaleConfig +// + +@implementation GTLRSQLAdmin_ReadPoolAutoScaleConfig +@dynamic disableScaleIn, enabled, maxNodeCount, minNodeCount, + scaleInCooldownSeconds, scaleOutCooldownSeconds, targetMetrics; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"targetMetrics" : [GTLRSQLAdmin_TargetMetric class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRSQLAdmin_ReplicaConfiguration @@ -2367,9 +2517,10 @@ @implementation GTLRSQLAdmin_Settings enableDataplexIntegration, enableGoogleMlIntegration, finalBackupConfig, insightsConfig, ipConfiguration, kind, locationPreference, maintenanceWindow, passwordValidationPolicy, - pricingPlan, replicationLagMaxSeconds, replicationType, - retainBackupsOnDelete, settingsVersion, sqlServerAuditConfig, - storageAutoResize, storageAutoResizeLimit, tier, timeZone, userLabels; + pricingPlan, readPoolAutoScaleConfig, replicationLagMaxSeconds, + replicationType, retainBackupsOnDelete, settingsVersion, + sqlServerAuditConfig, storageAutoResize, storageAutoResizeLimit, tier, + timeZone, userLabels; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -2461,10 +2612,11 @@ @implementation GTLRSQLAdmin_SqlInstancesAcquireSsrsLeaseResponse // @implementation GTLRSQLAdmin_SqlInstancesExecuteSqlResponse -@dynamic metadata, results; +@dynamic messages, metadata, results; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"messages" : [GTLRSQLAdmin_Message class], @"results" : [GTLRSQLAdmin_QueryResult class] }; return map; @@ -2774,6 +2926,16 @@ @implementation GTLRSQLAdmin_SyncFlags @end +// ---------------------------------------------------------------------------- +// +// GTLRSQLAdmin_TargetMetric +// + +@implementation GTLRSQLAdmin_TargetMetric +@dynamic metric, targetValue; +@end + + // ---------------------------------------------------------------------------- // // GTLRSQLAdmin_Tier @@ -2845,8 +3007,8 @@ + (BOOL)isKindValidForClassRegistry { // @implementation GTLRSQLAdmin_User -@dynamic dualPasswordType, ETag, host, instance, kind, name, password, - passwordPolicy, project, sqlserverUserDetails, type; +@dynamic dualPasswordType, ETag, host, iamStatus, instance, kind, name, + password, passwordPolicy, project, sqlserverUserDetails, type; + (NSDictionary *)propertyToJSONKeyMap { return @{ @"ETag" : @"etag" }; diff --git a/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminQuery.m b/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminQuery.m index 7a121f8c8..965d0fbc1 100644 --- a/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminQuery.m +++ b/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminQuery.m @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import @@ -18,6 +18,11 @@ NSString * const kGTLRSQLAdminFlagScopeSqlFlagScopeDatabase = @"SQL_FLAG_SCOPE_DATABASE"; NSString * const kGTLRSQLAdminFlagScopeSqlFlagScopeUnspecified = @"SQL_FLAG_SCOPE_UNSPECIFIED"; +// mode +NSString * const kGTLRSQLAdminModeAll = @"ALL"; +NSString * const kGTLRSQLAdminModeResetSslModeUnspecified = @"RESET_SSL_MODE_UNSPECIFIED"; +NSString * const kGTLRSQLAdminModeSyncFromPrimary = @"SYNC_FROM_PRIMARY"; + // ---------------------------------------------------------------------------- // Query Classes // @@ -983,6 +988,37 @@ + (instancetype)queryWithObject:(GTLRSQLAdmin_PointInTimeRestoreContext *)object @end +@implementation GTLRSQLAdminQuery_InstancesPreCheckMajorVersionUpgrade + +@dynamic instance, project; + ++ (instancetype)queryWithObject:(GTLRSQLAdmin_InstancesPreCheckMajorVersionUpgradeRequest *)object + project:(NSString *)project + instance:(NSString *)instance { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ + @"instance", @"project" + ]; + NSString *pathURITemplate = @"v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade"; + GTLRSQLAdminQuery_InstancesPreCheckMajorVersionUpgrade *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.project = project; + query.instance = instance; + query.expectedObjectClass = [GTLRSQLAdmin_Operation class]; + query.loggingName = @"sql.instances.preCheckMajorVersionUpgrade"; + return query; +} + +@end + @implementation GTLRSQLAdminQuery_InstancesPromoteReplica @dynamic failover, instance, project; @@ -1062,7 +1098,7 @@ + (instancetype)queryWithProject:(NSString *)project @implementation GTLRSQLAdminQuery_InstancesResetSslConfig -@dynamic instance, project; +@dynamic instance, mode, project; + (instancetype)queryWithProject:(NSString *)project instance:(NSString *)instance { diff --git a/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminService.m b/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminService.m index 3a2914356..cfeb1c6aa 100644 --- a/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminService.m +++ b/Sources/GeneratedServices/SQLAdmin/GTLRSQLAdminService.m @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import diff --git a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdmin.h b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdmin.h index 3a6332404..1cccc0f0b 100644 --- a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdmin.h +++ b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdmin.h @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import "GTLRSQLAdminObjects.h" #import "GTLRSQLAdminQuery.h" diff --git a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminObjects.h b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminObjects.h index 13186bb91..1ff730e14 100644 --- a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminObjects.h +++ b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminObjects.h @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import @@ -71,6 +71,7 @@ @class GTLRSQLAdmin_IpMapping; @class GTLRSQLAdmin_LocationPreference; @class GTLRSQLAdmin_MaintenanceWindow; +@class GTLRSQLAdmin_Message; @class GTLRSQLAdmin_Metadata; @class GTLRSQLAdmin_MySqlReplicaConfiguration; @class GTLRSQLAdmin_MySqlSyncConfig; @@ -81,9 +82,12 @@ @class GTLRSQLAdmin_PasswordStatus; @class GTLRSQLAdmin_PasswordValidationPolicy; @class GTLRSQLAdmin_PoolNodeConfig; +@class GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext; +@class GTLRSQLAdmin_PreCheckResponse; @class GTLRSQLAdmin_PscAutoConnectionConfig; @class GTLRSQLAdmin_PscConfig; @class GTLRSQLAdmin_QueryResult; +@class GTLRSQLAdmin_ReadPoolAutoScaleConfig; @class GTLRSQLAdmin_ReplicaConfiguration; @class GTLRSQLAdmin_ReplicationCluster; @class GTLRSQLAdmin_Reschedule; @@ -105,6 +109,7 @@ @class GTLRSQLAdmin_SslCert; @class GTLRSQLAdmin_SslCertDetail; @class GTLRSQLAdmin_SyncFlags; +@class GTLRSQLAdmin_TargetMetric; @class GTLRSQLAdmin_Tier; @class GTLRSQLAdmin_TruncateLogContext; @class GTLRSQLAdmin_User; @@ -394,6 +399,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres * Value: "POSTGRES_17" */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres17; +/** + * The database version is PostgreSQL 18. + * + * Value: "POSTGRES_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres18; /** * The database version is PostgreSQL 9.6. * @@ -894,6 +905,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postg * Value: "POSTGRES_17" */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres17; +/** + * The database version is PostgreSQL 18. + * + * Value: "POSTGRES_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres18; /** * The database version is PostgreSQL 9.6. * @@ -1308,6 +1325,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion * Value: "POSTGRES_17" */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres17; +/** + * The database version is PostgreSQL 18. + * + * Value: "POSTGRES_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres18; /** * The database version is PostgreSQL 9.6. * @@ -1680,6 +1703,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersio * Value: "POSTGRES_17" */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres17; +/** + * The database version is PostgreSQL 18. + * + * Value: "POSTGRES_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres18; /** * The database version is PostgreSQL 9.6. * @@ -2254,6 +2283,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres16; * Value: "POSTGRES_17" */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres17; +/** + * The database version is PostgreSQL 18. + * + * Value: "POSTGRES_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_Flag_AppliesTo_Postgres18; /** * The database version is PostgreSQL 9.6. * @@ -3067,6 +3102,338 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PoolNodeConfig_State_SqlInstanc */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PoolNodeConfig_State_Suspended; +// ---------------------------------------------------------------------------- +// GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext.targetDatabaseVersion + +/** + * The database version is MySQL 5.1. + * + * Value: "MYSQL_5_1" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql51 GTLR_DEPRECATED; +/** + * The database version is MySQL 5.5. + * + * Value: "MYSQL_5_5" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql55 GTLR_DEPRECATED; +/** + * The database version is MySQL 5.6. + * + * Value: "MYSQL_5_6" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql56; +/** + * The database version is MySQL 5.7. + * + * Value: "MYSQL_5_7" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql57; +/** + * The database version is MySQL 8. + * + * Value: "MYSQL_8_0" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql80; +/** + * The database major version is MySQL 8.0 and the minor version is 18. + * + * Value: "MYSQL_8_0_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8018; +/** + * The database major version is MySQL 8.0 and the minor version is 26. + * + * Value: "MYSQL_8_0_26" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8026; +/** + * The database major version is MySQL 8.0 and the minor version is 27. + * + * Value: "MYSQL_8_0_27" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8027; +/** + * The database major version is MySQL 8.0 and the minor version is 28. + * + * Value: "MYSQL_8_0_28" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8028; +/** + * The database major version is MySQL 8.0 and the minor version is 29. + * + * Value: "MYSQL_8_0_29" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8029 GTLR_DEPRECATED; +/** + * The database major version is MySQL 8.0 and the minor version is 30. + * + * Value: "MYSQL_8_0_30" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8030; +/** + * The database major version is MySQL 8.0 and the minor version is 31. + * + * Value: "MYSQL_8_0_31" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8031; +/** + * The database major version is MySQL 8.0 and the minor version is 32. + * + * Value: "MYSQL_8_0_32" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8032; +/** + * The database major version is MySQL 8.0 and the minor version is 33. + * + * Value: "MYSQL_8_0_33" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8033; +/** + * The database major version is MySQL 8.0 and the minor version is 34. + * + * Value: "MYSQL_8_0_34" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8034; +/** + * The database major version is MySQL 8.0 and the minor version is 35. + * + * Value: "MYSQL_8_0_35" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8035; +/** + * The database major version is MySQL 8.0 and the minor version is 36. + * + * Value: "MYSQL_8_0_36" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8036; +/** + * The database major version is MySQL 8.0 and the minor version is 37. + * + * Value: "MYSQL_8_0_37" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8037; +/** + * The database major version is MySQL 8.0 and the minor version is 39. + * + * Value: "MYSQL_8_0_39" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8039; +/** + * The database major version is MySQL 8.0 and the minor version is 40. + * + * Value: "MYSQL_8_0_40" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8040; +/** + * The database major version is MySQL 8.0 and the minor version is 41. + * + * Value: "MYSQL_8_0_41" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8041; +/** + * The database major version is MySQL 8.0 and the minor version is 42. + * + * Value: "MYSQL_8_0_42" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8042; +/** + * The database major version is MySQL 8.0 and the minor version is 43. + * + * Value: "MYSQL_8_0_43" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8043; +/** + * The database major version is MySQL 8.0 and the minor version is 44. + * + * Value: "MYSQL_8_0_44" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8044; +/** + * The database major version is MySQL 8.0 and the minor version is 45. + * + * Value: "MYSQL_8_0_45" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8045; +/** + * The database major version is MySQL 8.0 and the minor version is 46. + * + * Value: "MYSQL_8_0_46" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8046; +/** + * The database version is MySQL 8.4. + * + * Value: "MYSQL_8_4" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql84; +/** + * The database version is PostgreSQL 10. + * + * Value: "POSTGRES_10" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres10; +/** + * The database version is PostgreSQL 11. + * + * Value: "POSTGRES_11" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres11; +/** + * The database version is PostgreSQL 12. + * + * Value: "POSTGRES_12" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres12; +/** + * The database version is PostgreSQL 13. + * + * Value: "POSTGRES_13" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres13; +/** + * The database version is PostgreSQL 14. + * + * Value: "POSTGRES_14" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres14; +/** + * The database version is PostgreSQL 15. + * + * Value: "POSTGRES_15" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres15; +/** + * The database version is PostgreSQL 16. + * + * Value: "POSTGRES_16" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres16; +/** + * The database version is PostgreSQL 17. + * + * Value: "POSTGRES_17" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres17; +/** + * The database version is PostgreSQL 18. + * + * Value: "POSTGRES_18" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres18; +/** + * The database version is PostgreSQL 9.6. + * + * Value: "POSTGRES_9_6" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres96; +/** + * This is an unknown database version. + * + * Value: "SQL_DATABASE_VERSION_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_SqlDatabaseVersionUnspecified; +/** + * The database version is SQL Server 2017 Enterprise. + * + * Value: "SQLSERVER_2017_ENTERPRISE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Enterprise; +/** + * The database version is SQL Server 2017 Express. + * + * Value: "SQLSERVER_2017_EXPRESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Express; +/** + * The database version is SQL Server 2017 Standard. + * + * Value: "SQLSERVER_2017_STANDARD" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Standard; +/** + * The database version is SQL Server 2017 Web. + * + * Value: "SQLSERVER_2017_WEB" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Web; +/** + * The database version is SQL Server 2019 Enterprise. + * + * Value: "SQLSERVER_2019_ENTERPRISE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Enterprise; +/** + * The database version is SQL Server 2019 Express. + * + * Value: "SQLSERVER_2019_EXPRESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Express; +/** + * The database version is SQL Server 2019 Standard. + * + * Value: "SQLSERVER_2019_STANDARD" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Standard; +/** + * The database version is SQL Server 2019 Web. + * + * Value: "SQLSERVER_2019_WEB" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Web; +/** + * The database version is SQL Server 2022 Enterprise. + * + * Value: "SQLSERVER_2022_ENTERPRISE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Enterprise; +/** + * The database version is SQL Server 2022 Express. + * + * Value: "SQLSERVER_2022_EXPRESS" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Express; +/** + * The database version is SQL Server 2022 Standard. + * + * Value: "SQLSERVER_2022_STANDARD" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Standard; +/** + * The database version is SQL Server 2022 Web. + * + * Value: "SQLSERVER_2022_WEB" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Web; + +// ---------------------------------------------------------------------------- +// GTLRSQLAdmin_PreCheckResponse.messageType + +/** + * Errors that a user must resolve before proceeding with the upgrade. + * + * Value: "ERROR" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_Error; +/** + * General informational messages that don't require action. + * + * Value: "INFO" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_Info; +/** + * Default unspecified value to prevent unintended behavior changes. + * + * Value: "MESSAGE_TYPE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_MessageTypeUnspecified; +/** + * Warnings that might impact the upgrade but don't block it. + * + * Value: "WARNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_PreCheckResponse_MessageType_Warning; + // ---------------------------------------------------------------------------- // GTLRSQLAdmin_Reschedule.rescheduleType @@ -3457,6 +3824,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Typ * Value: "PG_CRON_FLAG_ENABLED_IN_REPLICA" */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgCronFlagEnabledInReplica; +/** + * The replication user is missing specific privileges to setup DDL + * replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL. + * + * Value: "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgDdlReplicationInsufficientPrivilege; /** * pglogical node already exists on databases, applicable for postgres. * @@ -3894,6 +4268,31 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_DualPasswordType_NoDualPas */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_DualPasswordType_NoModifyDualPassword; +// ---------------------------------------------------------------------------- +// GTLRSQLAdmin_User.iamStatus + +/** + * ACTIVE indicates a group is available for IAM database authentication. + * + * Value: "ACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_IamStatus_Active; +/** + * The default value for users that are not of type CLOUD_IAM_GROUP. Only + * CLOUD_IAM_GROUP users will be inactive or active. Users with an IamStatus of + * IAM_STATUS_UNSPECIFIED will not display whether they are active or inactive + * as that is not applicable to them. + * + * Value: "IAM_STATUS_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_IamStatus_IamStatusUnspecified; +/** + * INACTIVE indicates a group is not available for IAM database authentication. + * + * Value: "INACTIVE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_IamStatus_Inactive; + // ---------------------------------------------------------------------------- // GTLRSQLAdmin_User.type @@ -4057,7 +4456,7 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; /** - * A backup resource. Next ID: 30 + * A backup resource. */ @interface GTLRSQLAdmin_Backup : GTLRObject @@ -4182,6 +4581,8 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; * version is PostgreSQL 16. (Value: "POSTGRES_16") * @arg @c kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres17 The database * version is PostgreSQL 17. (Value: "POSTGRES_17") + * @arg @c kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres18 The database + * version is PostgreSQL 18. (Value: "POSTGRES_18") * @arg @c kGTLRSQLAdmin_Backup_DatabaseVersion_Postgres96 The database * version is PostgreSQL 9.6. (Value: "POSTGRES_9_6") * @arg @c kGTLRSQLAdmin_Backup_DatabaseVersion_SqlDatabaseVersionUnspecified @@ -4657,6 +5058,8 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; * version is PostgreSQL 16. (Value: "POSTGRES_16") * @arg @c kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres17 The database * version is PostgreSQL 17. (Value: "POSTGRES_17") + * @arg @c kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres18 The database + * version is PostgreSQL 18. (Value: "POSTGRES_18") * @arg @c kGTLRSQLAdmin_BackupRun_DatabaseVersion_Postgres96 The database * version is PostgreSQL 9.6. (Value: "POSTGRES_9_6") * @arg @c kGTLRSQLAdmin_BackupRun_DatabaseVersion_SqlDatabaseVersionUnspecified @@ -5162,6 +5565,8 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; * database version is PostgreSQL 16. (Value: "POSTGRES_16") * @arg @c kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres17 The * database version is PostgreSQL 17. (Value: "POSTGRES_17") + * @arg @c kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres18 The + * database version is PostgreSQL 18. (Value: "POSTGRES_18") * @arg @c kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_Postgres96 The * database version is PostgreSQL 9.6. (Value: "POSTGRES_9_6") * @arg @c kGTLRSQLAdmin_ConnectSettings_DatabaseVersion_SqlDatabaseVersionUnspecified @@ -5493,6 +5898,8 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; * database version is PostgreSQL 16. (Value: "POSTGRES_16") * @arg @c kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres17 The * database version is PostgreSQL 17. (Value: "POSTGRES_17") + * @arg @c kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres18 The + * database version is PostgreSQL 18. (Value: "POSTGRES_18") * @arg @c kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_Postgres96 The * database version is PostgreSQL 9.6. (Value: "POSTGRES_9_6") * @arg @c kGTLRSQLAdmin_DatabaseInstance_DatabaseVersion_SqlDatabaseVersionUnspecified @@ -7230,6 +7637,20 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; @end +/** + * Request for Pre-checks for MVU + */ +@interface GTLRSQLAdmin_InstancesPreCheckMajorVersionUpgradeRequest : GTLRObject + +/** + * Required. Contains details about the pre-check major version upgrade + * operation. + */ +@property(nonatomic, strong, nullable) GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext *preCheckMajorVersionUpgradeContext; + +@end + + /** * Database Instance reencrypt request. */ @@ -7640,6 +8061,27 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; @end +/** + * Represents a notice or warning message from the database. + */ +@interface GTLRSQLAdmin_Message : GTLRObject + +/** + * The full message string. For PostgreSQL, this is a formatted string that may + * include severity, code, and the notice/warning message. For MySQL, this + * contains the warning message. + */ +@property(nonatomic, copy, nullable) NSString *message; + +/** + * The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for + * MySQL). + */ +@property(nonatomic, copy, nullable) NSString *severity; + +@end + + /** * The additional metadata information regarding the execution of the SQL * statements. @@ -7980,6 +8422,15 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; */ @property(nonatomic, copy, nullable) NSString *operationType; +/** + * This field is only populated when the operation_type is + * PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext + * message itself contains the details for that pre-check, such as the target + * database version for the upgrade and the results of the check (including any + * warnings or errors found). + */ +@property(nonatomic, strong, nullable) GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext *preCheckMajorVersionUpgradeContext; + /** The URI of this resource. */ @property(nonatomic, copy, nullable) NSString *selfLink; @@ -8327,6 +8778,193 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; @end +/** + * Pre-check major version upgrade context. + */ +@interface GTLRSQLAdmin_PreCheckMajorVersionUpgradeContext : GTLRObject + +/** Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. */ +@property(nonatomic, copy, nullable) NSString *kind; + +/** Output only. The responses from the precheck operation. */ +@property(nonatomic, strong, nullable) NSArray *preCheckResponse; + +/** + * Required. The target database version to upgrade to. + * + * Likely values: + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql51 + * The database version is MySQL 5.1. (Value: "MYSQL_5_1") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql55 + * The database version is MySQL 5.5. (Value: "MYSQL_5_5") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql56 + * The database version is MySQL 5.6. (Value: "MYSQL_5_6") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql57 + * The database version is MySQL 5.7. (Value: "MYSQL_5_7") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql80 + * The database version is MySQL 8. (Value: "MYSQL_8_0") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8018 + * The database major version is MySQL 8.0 and the minor version is 18. + * (Value: "MYSQL_8_0_18") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8026 + * The database major version is MySQL 8.0 and the minor version is 26. + * (Value: "MYSQL_8_0_26") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8027 + * The database major version is MySQL 8.0 and the minor version is 27. + * (Value: "MYSQL_8_0_27") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8028 + * The database major version is MySQL 8.0 and the minor version is 28. + * (Value: "MYSQL_8_0_28") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8029 + * The database major version is MySQL 8.0 and the minor version is 29. + * (Value: "MYSQL_8_0_29") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8030 + * The database major version is MySQL 8.0 and the minor version is 30. + * (Value: "MYSQL_8_0_30") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8031 + * The database major version is MySQL 8.0 and the minor version is 31. + * (Value: "MYSQL_8_0_31") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8032 + * The database major version is MySQL 8.0 and the minor version is 32. + * (Value: "MYSQL_8_0_32") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8033 + * The database major version is MySQL 8.0 and the minor version is 33. + * (Value: "MYSQL_8_0_33") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8034 + * The database major version is MySQL 8.0 and the minor version is 34. + * (Value: "MYSQL_8_0_34") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8035 + * The database major version is MySQL 8.0 and the minor version is 35. + * (Value: "MYSQL_8_0_35") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8036 + * The database major version is MySQL 8.0 and the minor version is 36. + * (Value: "MYSQL_8_0_36") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8037 + * The database major version is MySQL 8.0 and the minor version is 37. + * (Value: "MYSQL_8_0_37") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8039 + * The database major version is MySQL 8.0 and the minor version is 39. + * (Value: "MYSQL_8_0_39") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8040 + * The database major version is MySQL 8.0 and the minor version is 40. + * (Value: "MYSQL_8_0_40") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8041 + * The database major version is MySQL 8.0 and the minor version is 41. + * (Value: "MYSQL_8_0_41") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8042 + * The database major version is MySQL 8.0 and the minor version is 42. + * (Value: "MYSQL_8_0_42") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8043 + * The database major version is MySQL 8.0 and the minor version is 43. + * (Value: "MYSQL_8_0_43") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8044 + * The database major version is MySQL 8.0 and the minor version is 44. + * (Value: "MYSQL_8_0_44") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8045 + * The database major version is MySQL 8.0 and the minor version is 45. + * (Value: "MYSQL_8_0_45") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql8046 + * The database major version is MySQL 8.0 and the minor version is 46. + * (Value: "MYSQL_8_0_46") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Mysql84 + * The database version is MySQL 8.4. (Value: "MYSQL_8_4") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres10 + * The database version is PostgreSQL 10. (Value: "POSTGRES_10") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres11 + * The database version is PostgreSQL 11. (Value: "POSTGRES_11") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres12 + * The database version is PostgreSQL 12. (Value: "POSTGRES_12") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres13 + * The database version is PostgreSQL 13. (Value: "POSTGRES_13") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres14 + * The database version is PostgreSQL 14. (Value: "POSTGRES_14") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres15 + * The database version is PostgreSQL 15. (Value: "POSTGRES_15") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres16 + * The database version is PostgreSQL 16. (Value: "POSTGRES_16") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres17 + * The database version is PostgreSQL 17. (Value: "POSTGRES_17") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres18 + * The database version is PostgreSQL 18. (Value: "POSTGRES_18") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Postgres96 + * The database version is PostgreSQL 9.6. (Value: "POSTGRES_9_6") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_SqlDatabaseVersionUnspecified + * This is an unknown database version. (Value: + * "SQL_DATABASE_VERSION_UNSPECIFIED") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Enterprise + * The database version is SQL Server 2017 Enterprise. (Value: + * "SQLSERVER_2017_ENTERPRISE") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Express + * The database version is SQL Server 2017 Express. (Value: + * "SQLSERVER_2017_EXPRESS") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Standard + * The database version is SQL Server 2017 Standard. (Value: + * "SQLSERVER_2017_STANDARD") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2017Web + * The database version is SQL Server 2017 Web. (Value: + * "SQLSERVER_2017_WEB") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Enterprise + * The database version is SQL Server 2019 Enterprise. (Value: + * "SQLSERVER_2019_ENTERPRISE") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Express + * The database version is SQL Server 2019 Express. (Value: + * "SQLSERVER_2019_EXPRESS") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Standard + * The database version is SQL Server 2019 Standard. (Value: + * "SQLSERVER_2019_STANDARD") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2019Web + * The database version is SQL Server 2019 Web. (Value: + * "SQLSERVER_2019_WEB") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Enterprise + * The database version is SQL Server 2022 Enterprise. (Value: + * "SQLSERVER_2022_ENTERPRISE") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Express + * The database version is SQL Server 2022 Express. (Value: + * "SQLSERVER_2022_EXPRESS") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Standard + * The database version is SQL Server 2022 Standard. (Value: + * "SQLSERVER_2022_STANDARD") + * @arg @c kGTLRSQLAdmin_PreCheckMajorVersionUpgradeContext_TargetDatabaseVersion_Sqlserver2022Web + * The database version is SQL Server 2022 Web. (Value: + * "SQLSERVER_2022_WEB") + */ +@property(nonatomic, copy, nullable) NSString *targetDatabaseVersion; + +@end + + +/** + * Structured PreCheckResponse containing message, type, and required actions. + */ +@interface GTLRSQLAdmin_PreCheckResponse : GTLRObject + +/** + * The actions that the user needs to take. Use repeated for multiple actions. + */ +@property(nonatomic, strong, nullable) NSArray *actionsRequired; + +/** The message to be displayed to the user. */ +@property(nonatomic, copy, nullable) NSString *message; + +/** + * The type of message whether it is an info, warning, or error. + * + * Likely values: + * @arg @c kGTLRSQLAdmin_PreCheckResponse_MessageType_Error Errors that a + * user must resolve before proceeding with the upgrade. (Value: "ERROR") + * @arg @c kGTLRSQLAdmin_PreCheckResponse_MessageType_Info General + * informational messages that don't require action. (Value: "INFO") + * @arg @c kGTLRSQLAdmin_PreCheckResponse_MessageType_MessageTypeUnspecified + * Default unspecified value to prevent unintended behavior changes. + * (Value: "MESSAGE_TYPE_UNSPECIFIED") + * @arg @c kGTLRSQLAdmin_PreCheckResponse_MessageType_Warning Warnings that + * might impact the upgrade but don't block it. (Value: "WARNING") + */ +@property(nonatomic, copy, nullable) NSString *messageType; + +@end + + /** * Settings for an automatically-setup Private Service Connect consumer * endpoint that is used to connect to a Cloud SQL instance. @@ -8425,6 +9063,60 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; @end +/** + * The read pool auto-scale configuration. + */ +@interface GTLRSQLAdmin_ReadPoolAutoScaleConfig : GTLRObject + +/** + * Indicates whether read pool auto scaling supports scale in operations + * (removing nodes). + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *disableScaleIn; + +/** + * Indicates whether read pool auto scaling is enabled. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *enabled; + +/** + * Maximum number of read pool nodes to be maintained. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxNodeCount; + +/** + * Minimum number of read pool nodes to be maintained. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *minNodeCount; + +/** + * The cooldown period for scale-in operations. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *scaleInCooldownSeconds; + +/** + * The cooldown period for scale-out operations. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *scaleOutCooldownSeconds; + +/** Optional. Target metrics for read pool auto scaling. */ +@property(nonatomic, strong, nullable) NSArray *targetMetrics; + +@end + + /** * Read-replica configuration for connecting to the primary instance. */ @@ -8870,6 +9562,9 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; */ @property(nonatomic, copy, nullable) NSString *pricingPlan; +/** Optional. The read pool auto-scale configuration for the instance. */ +@property(nonatomic, strong, nullable) GTLRSQLAdmin_ReadPoolAutoScaleConfig *readPoolAutoScaleConfig; + /** * Optional. Configuration value for recreation of replica after certain * replication lag @@ -9117,6 +9812,10 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; * The error message indicates that pg_cron flags are enabled on the * destination which is not supported during the migration. (Value: * "PG_CRON_FLAG_ENABLED_IN_REPLICA") + * @arg @c kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PgDdlReplicationInsufficientPrivilege + * The replication user is missing specific privileges to setup DDL + * replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for + * PostgreSQL. (Value: "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE") * @arg @c kGTLRSQLAdmin_SqlExternalSyncSettingError_Type_PglogicalNodeAlreadyExists * pglogical node already exists on databases, applicable for postgres. * (Value: "PGLOGICAL_NODE_ALREADY_EXISTS") @@ -9245,6 +9944,15 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; */ @interface GTLRSQLAdmin_SqlInstancesExecuteSqlResponse : GTLRObject +/** + * A list of notices and warnings generated during query execution. For + * PostgreSQL, this includes all notices and warnings. For MySQL, this includes + * warnings generated by the last executed statement. To retrieve all warnings + * for a multi-statement query, `SHOW WARNINGS` must be executed after each + * statement. + */ +@property(nonatomic, strong, nullable) NSArray *messages; + /** * The additional metadata information regarding the execution of the SQL * statements. @@ -9805,6 +10513,24 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; @end +/** + * Target metric for read pool auto scaling. + */ +@interface GTLRSQLAdmin_TargetMetric : GTLRObject + +/** The metric name to be used for auto scaling. */ +@property(nonatomic, copy, nullable) NSString *metric; + +/** + * The target value for the metric. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *targetValue; + +@end + + /** * A Google Cloud SQL service tier resource. */ @@ -9915,6 +10641,23 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdmin_User_Type_CloudIamUser; */ @property(nonatomic, copy, nullable) NSString *host; +/** + * Indicates if a group is active or inactive for IAM database authentication. + * + * Likely values: + * @arg @c kGTLRSQLAdmin_User_IamStatus_Active ACTIVE indicates a group is + * available for IAM database authentication. (Value: "ACTIVE") + * @arg @c kGTLRSQLAdmin_User_IamStatus_IamStatusUnspecified The default + * value for users that are not of type CLOUD_IAM_GROUP. Only + * CLOUD_IAM_GROUP users will be inactive or active. Users with an + * IamStatus of IAM_STATUS_UNSPECIFIED will not display whether they are + * active or inactive as that is not applicable to them. (Value: + * "IAM_STATUS_UNSPECIFIED") + * @arg @c kGTLRSQLAdmin_User_IamStatus_Inactive INACTIVE indicates a group + * is not available for IAM database authentication. (Value: "INACTIVE") + */ +@property(nonatomic, copy, nullable) NSString *iamStatus; + /** * The name of the Cloud SQL instance. This does not include the project ID. * Can be omitted for `update` because it is already specified on the URL. diff --git a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminQuery.h b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminQuery.h index 05032ec79..9ed37a1fb 100644 --- a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminQuery.h +++ b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminQuery.h @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import @@ -48,6 +48,29 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdminFlagScopeSqlFlagScopeDatabase; */ FOUNDATION_EXTERN NSString * const kGTLRSQLAdminFlagScopeSqlFlagScopeUnspecified; +// ---------------------------------------------------------------------------- +// mode + +/** + * Refresh all TLS configs. This is the default behaviour. + * + * Value: "ALL" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdminModeAll; +/** + * Reset SSL mode is not specified. + * + * Value: "RESET_SSL_MODE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdminModeResetSslModeUnspecified; +/** + * Refreshes the replication-related TLS configuration settings provided by the + * primary instance. Not applicable to on-premises replication instances. + * + * Value: "SYNC_FROM_PRIMARY" + */ +FOUNDATION_EXTERN NSString * const kGTLRSQLAdminModeSyncFromPrimary; + // ---------------------------------------------------------------------------- // Query Classes // @@ -1508,6 +1531,44 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdminFlagScopeSqlFlagScopeUnspecified @end +/** + * Execute MVU Pre-checks + * + * Method: sql.instances.preCheckMajorVersionUpgrade + * + * Authorization scope(s): + * @c kGTLRAuthScopeSQLAdminCloudPlatform + * @c kGTLRAuthScopeSQLAdminSqlserviceAdmin + */ +@interface GTLRSQLAdminQuery_InstancesPreCheckMajorVersionUpgrade : GTLRSQLAdminQuery + +/** Required. Cloud SQL instance ID. This does not include the project ID. */ +@property(nonatomic, copy, nullable) NSString *instance; + +/** Required. Project ID of the project that contains the instance. */ +@property(nonatomic, copy, nullable) NSString *project; + +/** + * Fetches a @c GTLRSQLAdmin_Operation. + * + * Execute MVU Pre-checks + * + * @param object The @c + * GTLRSQLAdmin_InstancesPreCheckMajorVersionUpgradeRequest to include in the + * query. + * @param project Required. Project ID of the project that contains the + * instance. + * @param instance Required. Cloud SQL instance ID. This does not include the + * project ID. + * + * @return GTLRSQLAdminQuery_InstancesPreCheckMajorVersionUpgrade + */ ++ (instancetype)queryWithObject:(GTLRSQLAdmin_InstancesPreCheckMajorVersionUpgradeRequest *)object + project:(NSString *)project + instance:(NSString *)instance; + +@end + /** * Promotes the read replica instance to be an independent Cloud SQL primary * instance. Using this operation might cause your instance to restart. @@ -1641,6 +1702,21 @@ FOUNDATION_EXTERN NSString * const kGTLRSQLAdminFlagScopeSqlFlagScopeUnspecified /** Cloud SQL instance ID. This does not include the project ID. */ @property(nonatomic, copy, nullable) NSString *instance; +/** + * Optional. Reset SSL mode to use. + * + * Likely values: + * @arg @c kGTLRSQLAdminModeResetSslModeUnspecified Reset SSL mode is not + * specified. (Value: "RESET_SSL_MODE_UNSPECIFIED") + * @arg @c kGTLRSQLAdminModeAll Refresh all TLS configs. This is the default + * behaviour. (Value: "ALL") + * @arg @c kGTLRSQLAdminModeSyncFromPrimary Refreshes the replication-related + * TLS configuration settings provided by the primary instance. Not + * applicable to on-premises replication instances. (Value: + * "SYNC_FROM_PRIMARY") + */ +@property(nonatomic, copy, nullable) NSString *mode; + /** Project ID of the project that contains the instance. */ @property(nonatomic, copy, nullable) NSString *project; diff --git a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminService.h b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminService.h index 266476e42..dea75904b 100644 --- a/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminService.h +++ b/Sources/GeneratedServices/SQLAdmin/Public/GoogleAPIClientForREST/GTLRSQLAdminService.h @@ -6,7 +6,7 @@ // Description: // API for Cloud SQL database instance management // Documentation: -// https://developers.google.com/cloud-sql/ +// https://cloud.google.com/sql/docs #import diff --git a/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementObjects.m b/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementObjects.m index 68deb0d41..a9e512f88 100644 --- a/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementObjects.m +++ b/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementObjects.m @@ -13,6 +13,13 @@ // ---------------------------------------------------------------------------- // Constants +// GTLRSaaSServiceManagement_ReplicationInternal.state +NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateFailed = @"REPLICATION_STATE_FAILED"; +NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStatePending = @"REPLICATION_STATE_PENDING"; +NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateRunning = @"REPLICATION_STATE_RUNNING"; +NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateSucceeded = @"REPLICATION_STATE_SUCCEEDED"; +NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateUnspecified = @"REPLICATION_STATE_UNSPECIFIED"; + // GTLRSaaSServiceManagement_Rollout.state NSString * const kGTLRSaaSServiceManagement_Rollout_State_RolloutStateCancelled = @"ROLLOUT_STATE_CANCELLED"; NSString * const kGTLRSaaSServiceManagement_Rollout_State_RolloutStateCancelling = @"ROLLOUT_STATE_CANCELLING"; @@ -256,6 +263,29 @@ + (NSString *)collectionItemsKey { @end +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ListReplicationsInternalResponse +// + +@implementation GTLRSaaSServiceManagement_ListReplicationsInternalResponse +@dynamic nextPageToken, replicationsInternal, unreachable; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"replicationsInternal" : [GTLRSaaSServiceManagement_ReplicationInternal class], + @"unreachable" : [NSString class] + }; + return map; +} + ++ (NSString *)collectionItemsKey { + return @"replicationsInternal"; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRSaaSServiceManagement_ListRolloutKindsResponse @@ -531,6 +561,108 @@ @implementation GTLRSaaSServiceManagement_ReleaseRequirements @end +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ReplicationInternal +// + +@implementation GTLRSaaSServiceManagement_ReplicationInternal +@dynamic annotations, createTime, ETag, labels, maxRetryCount, name, payload, + state, stats, targetLocations, uid, updateTime; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"ETag" : @"etag" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"targetLocations" : [NSString class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ReplicationInternal_Annotations +// + +@implementation GTLRSaaSServiceManagement_ReplicationInternal_Annotations + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ReplicationInternal_Labels +// + +@implementation GTLRSaaSServiceManagement_ReplicationInternal_Labels + ++ (Class)classForAdditionalProperties { + return [NSString class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ReplicationInternal_Payload +// + +@implementation GTLRSaaSServiceManagement_ReplicationInternal_Payload + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ReplicationInternal_Stats +// + +@implementation GTLRSaaSServiceManagement_ReplicationInternal_Stats + ++ (Class)classForAdditionalProperties { + return [GTLRSaaSServiceManagement_ReplicationStats class]; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_ReplicationStats +// + +@implementation GTLRSaaSServiceManagement_ReplicationStats +@dynamic errors, failedResources, finishedResources, pendingResources, + retryCount; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"errors" : [GTLRSaaSServiceManagement_Status class], + @"failedResources" : [NSString class], + @"finishedResources" : [NSString class], + @"pendingResources" : [NSString class], + @"retryCount" : [NSNumber class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRSaaSServiceManagement_Rollout @@ -725,6 +857,38 @@ @implementation GTLRSaaSServiceManagement_Schedule @end +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_Status +// + +@implementation GTLRSaaSServiceManagement_Status +@dynamic code, details, message; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"details" : [GTLRSaaSServiceManagement_Status_Details_Item class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRSaaSServiceManagement_Status_Details_Item +// + +@implementation GTLRSaaSServiceManagement_Status_Details_Item + ++ (Class)classForAdditionalProperties { + return [NSObject class]; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRSaaSServiceManagement_Tenant diff --git a/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementQuery.m b/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementQuery.m index 2158361f4..2cd72c9e5 100644 --- a/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementQuery.m +++ b/Sources/GeneratedServices/SaaSServiceManagement/GTLRSaaSServiceManagementQuery.m @@ -176,6 +176,125 @@ + (instancetype)queryWithObject:(GTLRSaaSServiceManagement_Release *)object @end +@implementation GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalCreate + +@dynamic parent, replicationInternalId, requestId, validateOnly; + ++ (instancetype)queryWithObject:(GTLRSaaSServiceManagement_ReplicationInternal *)object + parent:(NSString *)parent { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1beta1/{+parent}/replicationsInternal"; + GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalCreate *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"POST" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.parent = parent; + query.expectedObjectClass = [GTLRSaaSServiceManagement_ReplicationInternal class]; + query.loggingName = @"saasservicemgmt.projects.locations.replicationsInternal.create"; + return query; +} + +@end + +@implementation GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalDelete + +@dynamic ETag, name, requestId, validateOnly; + ++ (NSDictionary *)parameterNameMap { + return @{ @"ETag" : @"etag" }; +} + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1beta1/{+name}"; + GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalDelete *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"DELETE" + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRSaaSServiceManagement_Empty class]; + query.loggingName = @"saasservicemgmt.projects.locations.replicationsInternal.delete"; + return query; +} + +@end + +@implementation GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalGet + +@dynamic name; + ++ (instancetype)queryWithName:(NSString *)name { + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1beta1/{+name}"; + GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalGet *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.name = name; + query.expectedObjectClass = [GTLRSaaSServiceManagement_ReplicationInternal class]; + query.loggingName = @"saasservicemgmt.projects.locations.replicationsInternal.get"; + return query; +} + +@end + +@implementation GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalList + +@dynamic filter, orderBy, pageSize, pageToken, parent; + ++ (instancetype)queryWithParent:(NSString *)parent { + NSArray *pathParams = @[ @"parent" ]; + NSString *pathURITemplate = @"v1beta1/{+parent}/replicationsInternal"; + GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalList *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:nil + pathParameterNames:pathParams]; + query.parent = parent; + query.expectedObjectClass = [GTLRSaaSServiceManagement_ListReplicationsInternalResponse class]; + query.loggingName = @"saasservicemgmt.projects.locations.replicationsInternal.list"; + return query; +} + +@end + +@implementation GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalPatch + +@dynamic ETag, name, requestId, updateMask, validateOnly; + ++ (NSDictionary *)parameterNameMap { + return @{ @"ETag" : @"etag" }; +} + ++ (instancetype)queryWithObject:(GTLRSaaSServiceManagement_ReplicationInternal *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1beta1/{+name}"; + GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRSaaSServiceManagement_ReplicationInternal class]; + query.loggingName = @"saasservicemgmt.projects.locations.replicationsInternal.patch"; + return query; +} + +@end + @implementation GTLRSaaSServiceManagementQuery_ProjectsLocationsRolloutKindsCreate @dynamic parent, requestId, rolloutKindId, validateOnly; diff --git a/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementObjects.h b/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementObjects.h index b23afffce..4fe76cde0 100644 --- a/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementObjects.h +++ b/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementObjects.h @@ -30,6 +30,12 @@ @class GTLRSaaSServiceManagement_Release_Annotations; @class GTLRSaaSServiceManagement_Release_Labels; @class GTLRSaaSServiceManagement_ReleaseRequirements; +@class GTLRSaaSServiceManagement_ReplicationInternal; +@class GTLRSaaSServiceManagement_ReplicationInternal_Annotations; +@class GTLRSaaSServiceManagement_ReplicationInternal_Labels; +@class GTLRSaaSServiceManagement_ReplicationInternal_Payload; +@class GTLRSaaSServiceManagement_ReplicationInternal_Stats; +@class GTLRSaaSServiceManagement_ReplicationStats; @class GTLRSaaSServiceManagement_Rollout; @class GTLRSaaSServiceManagement_Rollout_Annotations; @class GTLRSaaSServiceManagement_Rollout_Labels; @@ -43,6 +49,8 @@ @class GTLRSaaSServiceManagement_Saas_Annotations; @class GTLRSaaSServiceManagement_Saas_Labels; @class GTLRSaaSServiceManagement_Schedule; +@class GTLRSaaSServiceManagement_Status; +@class GTLRSaaSServiceManagement_Status_Details_Item; @class GTLRSaaSServiceManagement_Tenant; @class GTLRSaaSServiceManagement_Tenant_Annotations; @class GTLRSaaSServiceManagement_Tenant_Labels; @@ -73,6 +81,40 @@ NS_ASSUME_NONNULL_BEGIN // ---------------------------------------------------------------------------- // Constants - For some of the classes' properties below. +// ---------------------------------------------------------------------------- +// GTLRSaaSServiceManagement_ReplicationInternal.state + +/** + * Replication has failed. + * + * Value: "REPLICATION_STATE_FAILED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateFailed; +/** + * Replication is pending. + * + * Value: "REPLICATION_STATE_PENDING" + */ +FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStatePending; +/** + * Replication is running. + * + * Value: "REPLICATION_STATE_RUNNING" + */ +FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateRunning; +/** + * Replication has succeeded. + * + * Value: "REPLICATION_STATE_SUCCEEDED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateSucceeded; +/** + * Unspecified state. + * + * Value: "REPLICATION_STATE_UNSPECIFIED" + */ +FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateUnspecified; + // ---------------------------------------------------------------------------- // GTLRSaaSServiceManagement_Rollout.state @@ -756,6 +798,37 @@ FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_UnitVariable_Type_ @end +/** + * The response structure for the ListReplicationsInternal method. + * + * @note This class supports NSFastEnumeration and indexed subscripting over + * its "replicationsInternal" property. If returned as the result of a + * query, it should support automatic pagination (when @c + * shouldFetchNextPages is enabled). + */ +@interface GTLRSaaSServiceManagement_ListReplicationsInternalResponse : GTLRCollectionObject + +/** + * If present, the next page token can be provided to a subsequent + * ListReplicationsInternal call to list the next page. If empty, there are no + * more pages. + */ +@property(nonatomic, copy, nullable) NSString *nextPageToken; + +/** + * The resulting replication internals. + * + * @note This property is used to support NSFastEnumeration and indexed + * subscripting on this class. + */ +@property(nonatomic, strong, nullable) NSArray *replicationsInternal; + +/** Locations that could not be reached. */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + +@end + + /** * The response structure for the ListRolloutKinds method. * @@ -1151,6 +1224,192 @@ FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_UnitVariable_Type_ @end +/** + * ReplicationInternal is a resource that represents the replication of a + * resource to multiple locations. This is an internal resource to achieve + * replication before GA and will not expose to the public API. + */ +@interface GTLRSaaSServiceManagement_ReplicationInternal : GTLRObject + +/** + * Optional. Annotations is an unstructured key-value map stored with a + * resource that may be set by external tools to store and retrieve arbitrary + * metadata. They are not queryable and should be preserved when modifying + * objects. More info: https://kubernetes.io/docs/user-guide/annotations + */ +@property(nonatomic, strong, nullable) GTLRSaaSServiceManagement_ReplicationInternal_Annotations *annotations; + +/** Output only. The timestamp when the resource was created. */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * Output only. An opaque value that uniquely identifies a version or + * generation of a resource. It can be used to confirm that the client and + * server agree on the ordering of a resource being written. + */ +@property(nonatomic, copy, nullable) NSString *ETag; + +/** + * Optional. The labels on the resource, which can be used for categorization. + * similar to Kubernetes resource labels. + */ +@property(nonatomic, strong, nullable) GTLRSaaSServiceManagement_ReplicationInternal_Labels *labels; + +/** + * Optional. The maximum number of retries for the replication. If the + * replication fails from a retryable error, it will be retried for this number + * of times. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *maxRetryCount; + +/** + * Identifier. The resource name (full URI of the resource) following the + * standard naming scheme: + * "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}" + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Required. The payload of the request for replication. It could be any + * request type that is supported by the replication service. e.g. + * CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc. + */ +@property(nonatomic, strong, nullable) GTLRSaaSServiceManagement_ReplicationInternal_Payload *payload; + +/** + * Output only. The state of the replication. + * + * Likely values: + * @arg @c kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateFailed + * Replication has failed. (Value: "REPLICATION_STATE_FAILED") + * @arg @c kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStatePending + * Replication is pending. (Value: "REPLICATION_STATE_PENDING") + * @arg @c kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateRunning + * Replication is running. (Value: "REPLICATION_STATE_RUNNING") + * @arg @c kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateSucceeded + * Replication has succeeded. (Value: "REPLICATION_STATE_SUCCEEDED") + * @arg @c kGTLRSaaSServiceManagement_ReplicationInternal_State_ReplicationStateUnspecified + * Unspecified state. (Value: "REPLICATION_STATE_UNSPECIFIED") + */ +@property(nonatomic, copy, nullable) NSString *state; + +/** + * Output only. The stats of the replication. One key for each location in + * target_locations + */ +@property(nonatomic, strong, nullable) GTLRSaaSServiceManagement_ReplicationInternal_Stats *stats; + +/** Optional. The target locations to replicate the resource to. */ +@property(nonatomic, strong, nullable) NSArray *targetLocations; + +/** + * Output only. The unique identifier of the resource. UID is unique in the + * time and space for this resource within the scope of the service. It is + * typically generated by the server on successful creation of a resource and + * must not be changed. UID is used to uniquely identify resources with + * resource name reuses. This should be a UUID4. + */ +@property(nonatomic, copy, nullable) NSString *uid; + +/** + * Output only. The timestamp when the resource was last updated. Any change to + * the resource made by users must refresh this value. Changes to a resource + * made by the service should refresh this value. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * Optional. Annotations is an unstructured key-value map stored with a + * resource that may be set by external tools to store and retrieve arbitrary + * metadata. They are not queryable and should be preserved when modifying + * objects. More info: https://kubernetes.io/docs/user-guide/annotations + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRSaaSServiceManagement_ReplicationInternal_Annotations : GTLRObject +@end + + +/** + * Optional. The labels on the resource, which can be used for categorization. + * similar to Kubernetes resource labels. + * + * @note This class is documented as having more properties of NSString. Use @c + * -additionalJSONKeys and @c -additionalPropertyForName: to get the list + * of properties and then fetch them; or @c -additionalProperties to + * fetch them all at once. + */ +@interface GTLRSaaSServiceManagement_ReplicationInternal_Labels : GTLRObject +@end + + +/** + * Required. The payload of the request for replication. It could be any + * request type that is supported by the replication service. e.g. + * CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc. + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRSaaSServiceManagement_ReplicationInternal_Payload : GTLRObject +@end + + +/** + * Output only. The stats of the replication. One key for each location in + * target_locations + * + * @note This class is documented as having more properties of + * GTLRSaaSServiceManagement_ReplicationStats. Use @c -additionalJSONKeys + * and @c -additionalPropertyForName: to get the list of properties and + * then fetch them; or @c -additionalProperties to fetch them all at + * once. + */ +@interface GTLRSaaSServiceManagement_ReplicationInternal_Stats : GTLRObject +@end + + +/** + * ReplicationStats contains the stats of the replication. It contains the + * resources that are pending, finished, failed, and the errors if any. + */ +@interface GTLRSaaSServiceManagement_ReplicationStats : GTLRObject + +/** + * The errors that occurred during replication, one error for each failed + * resource. + */ +@property(nonatomic, strong, nullable) NSArray *errors; + +/** The resources that are failed replication. */ +@property(nonatomic, strong, nullable) NSArray *failedResources; + +/** The resources that are finished replication. */ +@property(nonatomic, strong, nullable) NSArray *finishedResources; + +/** The resources that are pending replication. */ +@property(nonatomic, strong, nullable) NSArray *pendingResources; + +/** + * The number of retries for the failed resources. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSArray *retryCount; + +@end + + /** * Represents a single rollout execution and its results */ @@ -1658,6 +1917,51 @@ FOUNDATION_EXTERN NSString * const kGTLRSaaSServiceManagement_UnitVariable_Type_ @end +/** + * 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). + */ +@interface GTLRSaaSServiceManagement_Status : GTLRObject + +/** + * The status code, which should be an enum value of google.rpc.Code. + * + * Uses NSNumber of intValue. + */ +@property(nonatomic, strong, nullable) NSNumber *code; + +/** + * A list of messages that carry the error details. There is a common set of + * message types for APIs to use. + */ +@property(nonatomic, strong, nullable) NSArray *details; + +/** + * 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. + */ +@property(nonatomic, copy, nullable) NSString *message; + +@end + + +/** + * GTLRSaaSServiceManagement_Status_Details_Item + * + * @note This class is documented as having more properties of any valid JSON + * type. Use @c -additionalJSONKeys and @c -additionalPropertyForName: to + * get the list of properties and then fetch them; or @c + * -additionalProperties to fetch them all at once. + */ +@interface GTLRSaaSServiceManagement_Status_Details_Item : GTLRObject +@end + + /** * Tenant represents the service producer side of an instance of the service * created based on a request from a consumer. In a typical scenario a Tenant diff --git a/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementQuery.h b/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementQuery.h index 15925e6b5..765cafc63 100644 --- a/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementQuery.h +++ b/Sources/GeneratedServices/SaaSServiceManagement/Public/GoogleAPIClientForREST/GTLRSaaSServiceManagementQuery.h @@ -70,8 +70,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRSaaSServiceManagementQuery_ProjectsLocationsList : GTLRSaaSServiceManagementQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -362,6 +362,266 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Create a new replication internal. + * + * Method: saasservicemgmt.projects.locations.replicationsInternal.create + * + * Authorization scope(s): + * @c kGTLRAuthScopeSaaSServiceManagementCloudPlatform + */ +@interface GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalCreate : GTLRSaaSServiceManagementQuery + +/** Required. The parent of the replication internal. */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** Required. The ID value for the new replication internal. */ +@property(nonatomic, copy, nullable) NSString *replicationInternalId; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. The server will guarantee that for + * at least 60 minutes since the first request. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check if + * original operation with the same request ID was received, and if so, will + * ignore the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * If "validate_only" is set to true, the service will try to validate that + * this request would succeed, but will not actually make changes. + */ +@property(nonatomic, assign) BOOL validateOnly; + +/** + * Fetches a @c GTLRSaaSServiceManagement_ReplicationInternal. + * + * Create a new replication internal. + * + * @param object The @c GTLRSaaSServiceManagement_ReplicationInternal to + * include in the query. + * @param parent Required. The parent of the replication internal. + * + * @return GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalCreate + */ ++ (instancetype)queryWithObject:(GTLRSaaSServiceManagement_ReplicationInternal *)object + parent:(NSString *)parent; + +@end + +/** + * Delete a single replication internal. + * + * Method: saasservicemgmt.projects.locations.replicationsInternal.delete + * + * Authorization scope(s): + * @c kGTLRAuthScopeSaaSServiceManagementCloudPlatform + */ +@interface GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalDelete : GTLRSaaSServiceManagementQuery + +/** + * The etag known to the client for the expected state of the replication + * internal. This is used with state-changing methods to prevent accidental + * overwrites when multiple user agents might be acting in parallel on the same + * resource. An etag wildcard provide optimistic concurrency based on the + * expected existence of the replication internal. The Any wildcard (`*`) + * requires that the resource must already exists, and the Not Any wildcard + * (`!*`) requires that it must not. + */ +@property(nonatomic, copy, nullable) NSString *ETag; + +/** Required. The resource name of the resource within a service. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. The server will guarantee that for + * at least 60 minutes since the first request. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check if + * original operation with the same request ID was received, and if so, will + * ignore the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * If "validate_only" is set to true, the service will try to validate that + * this request would succeed, but will not actually make changes. + */ +@property(nonatomic, assign) BOOL validateOnly; + +/** + * Fetches a @c GTLRSaaSServiceManagement_Empty. + * + * Delete a single replication internal. + * + * @param name Required. The resource name of the resource within a service. + * + * @return GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalDelete + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Retrieve a single replication internal. + * + * Method: saasservicemgmt.projects.locations.replicationsInternal.get + * + * Authorization scope(s): + * @c kGTLRAuthScopeSaaSServiceManagementCloudPlatform + */ +@interface GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalGet : GTLRSaaSServiceManagementQuery + +/** Required. The resource name of the resource within a service. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Fetches a @c GTLRSaaSServiceManagement_ReplicationInternal. + * + * Retrieve a single replication internal. + * + * @param name Required. The resource name of the resource within a service. + * + * @return GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalGet + */ ++ (instancetype)queryWithName:(NSString *)name; + +@end + +/** + * Retrieve a collection of replication internals. + * + * Method: saasservicemgmt.projects.locations.replicationsInternal.list + * + * Authorization scope(s): + * @c kGTLRAuthScopeSaaSServiceManagementCloudPlatform + */ +@interface GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalList : GTLRSaaSServiceManagementQuery + +/** Filter the list as specified in https://google.aip.dev/160. */ +@property(nonatomic, copy, nullable) NSString *filter; + +/** Order results as specified in https://google.aip.dev/132. */ +@property(nonatomic, copy, nullable) NSString *orderBy; + +/** The maximum number of replication internals to send per page. */ +@property(nonatomic, assign) NSInteger pageSize; + +/** + * The page token: If the next_page_token from a previous response is provided, + * this request will send the subsequent page. + */ +@property(nonatomic, copy, nullable) NSString *pageToken; + +/** Required. The parent of the replication internal. */ +@property(nonatomic, copy, nullable) NSString *parent; + +/** + * Fetches a @c GTLRSaaSServiceManagement_ListReplicationsInternalResponse. + * + * Retrieve a collection of replication internals. + * + * @param parent Required. The parent of the replication internal. + * + * @return GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalList + * + * @note Automatic pagination will be done when @c shouldFetchNextPages is + * enabled. See @c shouldFetchNextPages on @c GTLRService for more + * information. + */ ++ (instancetype)queryWithParent:(NSString *)parent; + +@end + +/** + * Update a single replication internal. + * + * Method: saasservicemgmt.projects.locations.replicationsInternal.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeSaaSServiceManagementCloudPlatform + */ +@interface GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalPatch : GTLRSaaSServiceManagementQuery + +/** + * The etag known to the client for the expected state of the replication + * internal. This is used with state-changing methods to prevent accidental + * overwrites when multiple user agents might be acting in parallel on the same + * resource. An etag wildcard provide optimistic concurrency based on the + * expected existence of the replication internal. The Any wildcard (`*`) + * requires that the resource must already exists, and the Not Any wildcard + * (`!*`) requires that it must not. + */ +@property(nonatomic, copy, nullable) NSString *ETag; + +/** + * Identifier. The resource name (full URI of the resource) following the + * standard naming scheme: + * "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}" + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. The server will guarantee that for + * at least 60 minutes since the first request. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check if + * original operation with the same request ID was received, and if so, will + * ignore the second request. This prevents clients from accidentally creating + * duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Field mask is used to specify the fields to be overwritten in the + * ReplicationInternal resource by the update. The fields specified in the + * update_mask are relative to the resource, not the full request. A field will + * be overwritten if it is in the mask. If the user does not provide a mask + * then all fields in the ReplicationInternal will be overwritten. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * If "validate_only" is set to true, the service will try to validate that + * this request would succeed, but will not actually make changes. + */ +@property(nonatomic, assign) BOOL validateOnly; + +/** + * Fetches a @c GTLRSaaSServiceManagement_ReplicationInternal. + * + * Update a single replication internal. + * + * @param object The @c GTLRSaaSServiceManagement_ReplicationInternal to + * include in the query. + * @param name Identifier. The resource name (full URI of the resource) + * following the standard naming scheme: + * "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}" + * + * @return GTLRSaaSServiceManagementQuery_ProjectsLocationsReplicationsInternalPatch + */ ++ (instancetype)queryWithObject:(GTLRSaaSServiceManagement_ReplicationInternal *)object + name:(NSString *)name; + +@end + /** * Create a new rollout kind. * diff --git a/Sources/GeneratedServices/SecretManager/Public/GoogleAPIClientForREST/GTLRSecretManagerQuery.h b/Sources/GeneratedServices/SecretManager/Public/GoogleAPIClientForREST/GTLRSecretManagerQuery.h index 5432e0f3d..2f074dcb3 100644 --- a/Sources/GeneratedServices/SecretManager/Public/GoogleAPIClientForREST/GTLRSecretManagerQuery.h +++ b/Sources/GeneratedServices/SecretManager/Public/GoogleAPIClientForREST/GTLRSecretManagerQuery.h @@ -71,8 +71,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRSecretManagerQuery_ProjectsLocationsList : GTLRSecretManagerQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/SecurityCommandCenter/GTLRSecurityCommandCenterObjects.m b/Sources/GeneratedServices/SecurityCommandCenter/GTLRSecurityCommandCenterObjects.m index 38261eb52..423be263d 100644 --- a/Sources/GeneratedServices/SecurityCommandCenter/GTLRSecurityCommandCenterObjects.m +++ b/Sources/GeneratedServices/SecurityCommandCenter/GTLRSecurityCommandCenterObjects.m @@ -16,6 +16,8 @@ // GTLRSecurityCommandCenter_AiModel.deploymentPlatform NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_DeploymentPlatformUnspecified = @"DEPLOYMENT_PLATFORM_UNSPECIFIED"; +NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_FineTunedModel = @"FINE_TUNED_MODEL"; +NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_Gce = @"GCE"; NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_Gke = @"GKE"; NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_VertexAi = @"VERTEX_AI"; @@ -140,6 +142,8 @@ // GTLRSecurityCommandCenter_DataRetentionDeletionEvent.eventType NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlExceeded = @"EVENT_TYPE_MAX_TTL_EXCEEDED"; +NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromCreation = @"EVENT_TYPE_MAX_TTL_FROM_CREATION"; +NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromLastModification = @"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"; NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeUnspecified = @"EVENT_TYPE_UNSPECIFIED"; // GTLRSecurityCommandCenter_EffectiveEventThreatDetectionCustomModule.cloudProvider @@ -315,6 +319,8 @@ // GTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel.deploymentPlatform NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_DeploymentPlatformUnspecified = @"DEPLOYMENT_PLATFORM_UNSPECIFIED"; +NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_FineTunedModel = @"FINE_TUNED_MODEL"; +NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_Gce = @"GCE"; NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_Gke = @"GKE"; NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_VertexAi = @"VERTEX_AI"; @@ -416,6 +422,8 @@ // GTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent.eventType NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlExceeded = @"EVENT_TYPE_MAX_TTL_EXCEEDED"; +NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromCreation = @"EVENT_TYPE_MAX_TTL_FROM_CREATION"; +NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromLastModification = @"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"; NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeUnspecified = @"EVENT_TYPE_UNSPECIFIED"; // GTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2FileOperation.type diff --git a/Sources/GeneratedServices/SecurityCommandCenter/Public/GoogleAPIClientForREST/GTLRSecurityCommandCenterObjects.h b/Sources/GeneratedServices/SecurityCommandCenter/Public/GoogleAPIClientForREST/GTLRSecurityCommandCenterObjects.h index 6e01f6d44..c9f3fe7f3 100644 --- a/Sources/GeneratedServices/SecurityCommandCenter/Public/GoogleAPIClientForREST/GTLRSecurityCommandCenterObjects.h +++ b/Sources/GeneratedServices/SecurityCommandCenter/Public/GoogleAPIClientForREST/GTLRSecurityCommandCenterObjects.h @@ -327,6 +327,18 @@ NS_ASSUME_NONNULL_BEGIN * Value: "DEPLOYMENT_PLATFORM_UNSPECIFIED" */ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_DeploymentPlatformUnspecified; +/** + * Fine tuned model. + * + * Value: "FINE_TUNED_MODEL" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_FineTunedModel; +/** + * Google Compute Engine. + * + * Value: "GCE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_Gce; /** * Google Kubernetes Engine. * @@ -931,6 +943,18 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_DataFlowEvent_Oper * Value: "EVENT_TYPE_MAX_TTL_EXCEEDED" */ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlExceeded; +/** + * Max TTL from the asset's creation time. + * + * Value: "EVENT_TYPE_MAX_TTL_FROM_CREATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromCreation; +/** + * Max TTL from the asset's last modification time. + * + * Value: "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromLastModification; /** * Unspecified event type. * @@ -1807,6 +1831,18 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecurit * Value: "DEPLOYMENT_PLATFORM_UNSPECIFIED" */ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_DeploymentPlatformUnspecified; +/** + * Fine tuned model. + * + * Value: "FINE_TUNED_MODEL" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_FineTunedModel; +/** + * Google Compute Engine. + * + * Value: "GCE" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_Gce; /** * Google Kubernetes Engine. * @@ -2302,6 +2338,18 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecurit * Value: "EVENT_TYPE_MAX_TTL_EXCEEDED" */ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlExceeded; +/** + * Max TTL from the asset's creation time. + * + * Value: "EVENT_TYPE_MAX_TTL_FROM_CREATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromCreation; +/** + * Max TTL from the asset's last modification time. + * + * Value: "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION" + */ +FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromLastModification; /** * Unspecified event type. * @@ -7587,6 +7635,10 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_VulnerabilitySnaps * @arg @c kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_DeploymentPlatformUnspecified * Unspecified deployment platform. (Value: * "DEPLOYMENT_PLATFORM_UNSPECIFIED") + * @arg @c kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_FineTunedModel + * Fine tuned model. (Value: "FINE_TUNED_MODEL") + * @arg @c kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_Gce Google + * Compute Engine. (Value: "GCE") * @arg @c kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_Gke Google * Kubernetes Engine. (Value: "GKE") * @arg @c kGTLRSecurityCommandCenter_AiModel_DeploymentPlatform_VertexAi @@ -9344,6 +9396,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_VulnerabilitySnaps * @arg @c kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlExceeded * The maximum retention time has been exceeded. (Value: * "EVENT_TYPE_MAX_TTL_EXCEEDED") + * @arg @c kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromCreation + * Max TTL from the asset's creation time. (Value: + * "EVENT_TYPE_MAX_TTL_FROM_CREATION") + * @arg @c kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromLastModification + * Max TTL from the asset's last modification time. (Value: + * "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION") * @arg @c kGTLRSecurityCommandCenter_DataRetentionDeletionEvent_EventType_EventTypeUnspecified * Unspecified event type. (Value: "EVENT_TYPE_UNSPECIFIED") */ @@ -11785,6 +11843,10 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_VulnerabilitySnaps * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_DeploymentPlatformUnspecified * Unspecified deployment platform. (Value: * "DEPLOYMENT_PLATFORM_UNSPECIFIED") + * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_FineTunedModel + * Fine tuned model. (Value: "FINE_TUNED_MODEL") + * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_Gce + * Google Compute Engine. (Value: "GCE") * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_Gke * Google Kubernetes Engine. (Value: "GKE") * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2AiModel_DeploymentPlatform_VertexAi @@ -13132,6 +13194,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSecurityCommandCenter_VulnerabilitySnaps * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlExceeded * The maximum retention time has been exceeded. (Value: * "EVENT_TYPE_MAX_TTL_EXCEEDED") + * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromCreation + * Max TTL from the asset's creation time. (Value: + * "EVENT_TYPE_MAX_TTL_FROM_CREATION") + * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeMaxTtlFromLastModification + * Max TTL from the asset's last modification time. (Value: + * "EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION") * @arg @c kGTLRSecurityCommandCenter_GoogleCloudSecuritycenterV2DataRetentionDeletionEvent_EventType_EventTypeUnspecified * Unspecified event type. (Value: "EVENT_TYPE_UNSPECIFIED") */ diff --git a/Sources/GeneratedServices/ServerlessVPCAccess/Public/GoogleAPIClientForREST/GTLRServerlessVPCAccessQuery.h b/Sources/GeneratedServices/ServerlessVPCAccess/Public/GoogleAPIClientForREST/GTLRServerlessVPCAccessQuery.h index 5c7eaf2a3..044bebf99 100644 --- a/Sources/GeneratedServices/ServerlessVPCAccess/Public/GoogleAPIClientForREST/GTLRServerlessVPCAccessQuery.h +++ b/Sources/GeneratedServices/ServerlessVPCAccess/Public/GoogleAPIClientForREST/GTLRServerlessVPCAccessQuery.h @@ -216,8 +216,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRServerlessVPCAccessQuery_ProjectsLocationsList : GTLRServerlessVPCAccessQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/ServiceConsumerManagement/GTLRServiceConsumerManagementObjects.m b/Sources/GeneratedServices/ServiceConsumerManagement/GTLRServiceConsumerManagementObjects.m index 17e18875e..0c4864618 100644 --- a/Sources/GeneratedServices/ServiceConsumerManagement/GTLRServiceConsumerManagementObjects.m +++ b/Sources/GeneratedServices/ServiceConsumerManagement/GTLRServiceConsumerManagementObjects.m @@ -183,7 +183,8 @@ @implementation GTLRServiceConsumerManagement_AddTenantProjectRequest // @implementation GTLRServiceConsumerManagement_Api -@dynamic methods, mixins, name, options, sourceContext, syntax, version; +@dynamic edition, methods, mixins, name, options, sourceContext, syntax, + version; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -1050,8 +1051,8 @@ @implementation GTLRServiceConsumerManagement_LongRunning // @implementation GTLRServiceConsumerManagement_Method -@dynamic name, options, requestStreaming, requestTypeUrl, responseStreaming, - responseTypeUrl, syntax; +@dynamic edition, name, options, requestStreaming, requestTypeUrl, + responseStreaming, responseTypeUrl, syntax; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ diff --git a/Sources/GeneratedServices/ServiceConsumerManagement/Public/GoogleAPIClientForREST/GTLRServiceConsumerManagementObjects.h b/Sources/GeneratedServices/ServiceConsumerManagement/Public/GoogleAPIClientForREST/GTLRServiceConsumerManagementObjects.h index 4f65cba47..ea1c61c6c 100644 --- a/Sources/GeneratedServices/ServiceConsumerManagement/Public/GoogleAPIClientForREST/GTLRServiceConsumerManagementObjects.h +++ b/Sources/GeneratedServices/ServiceConsumerManagement/Public/GoogleAPIClientForREST/GTLRServiceConsumerManagementObjects.h @@ -1024,10 +1024,17 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa * opposed to simply a description of methods and bindings. They are also * sometimes simply referred to as "APIs" in other contexts, such as the name * of this message itself. See https://cloud.google.com/apis/design/glossary - * for detailed terminology. + * for detailed terminology. New usages of this message as an alternative to + * ServiceDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceConsumerManagement_Api : GTLRObject +/** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */ +@property(nonatomic, copy, nullable) NSString *edition; + /** The methods of this interface, in unspecified order. */ @property(nonatomic, strong, nullable) NSArray *methods; @@ -1395,7 +1402,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa @property(nonatomic, strong, nullable) GTLRServiceConsumerManagement_BackendRule_OverridesByRequestProtocol *overridesByRequestProtocol; /** - * pathTranslation + * no-lint * * Likely values: * @arg @c kGTLRServiceConsumerManagement_BackendRule_PathTranslation_AppendPathToAddress @@ -2217,7 +2224,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to + * EnumDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceConsumerManagement_Enum : GTLRObject @@ -2253,7 +2264,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to + * EnumValueDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceConsumerManagement_EnumValue : GTLRObject @@ -2313,7 +2328,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an + * alternative to FieldDescriptorProto are strongly discouraged. This message + * does not reliability preserve all information necessary to model the schema + * and preserve semantics. Instead make use of FileDescriptorSet which + * preserves the necessary information. */ @interface GTLRServiceConsumerManagement_Field : GTLRObject @@ -2468,7 +2487,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** * Map of service names to renamed services. Keys are the package relative * service names and values are the name to be used for the service client and - * call options. publishing: go_settings: renamed_services: Publisher: + * call options. Example: publishing: go_settings: renamed_services: Publisher: * TopicAdmin */ @property(nonatomic, strong, nullable) GTLRServiceConsumerManagement_GoSettings_RenamedServices *renamedServices; @@ -2479,7 +2498,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** * Map of service names to renamed services. Keys are the package relative * service names and values are the name to be used for the service client and - * call options. publishing: go_settings: renamed_services: Publisher: + * call options. Example: publishing: go_settings: renamed_services: Publisher: * TopicAdmin * * @note This class is documented as having more properties of NSString. Use @c @@ -3008,10 +3027,21 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** - * Method represents a method of an API interface. + * Method represents a method of an API interface. New usages of this message + * as an alternative to MethodDescriptorProto are strongly discouraged. This + * message does not reliability preserve all information necessary to model the + * schema and preserve semantics. Instead make use of FileDescriptorSet which + * preserves the necessary information. */ @interface GTLRServiceConsumerManagement_Method : GTLRObject +/** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This + * field should be ignored, instead the edition should be inherited from Api. + * This is similar to Field and EnumValue. + */ +@property(nonatomic, copy, nullable) NSString *edition GTLR_DEPRECATED; + /** The simple name of this method. */ @property(nonatomic, copy, nullable) NSString *name; @@ -3039,7 +3069,8 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa @property(nonatomic, copy, nullable) NSString *responseTypeUrl; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the + * syntax should be inherited from Api. This is similar to Field and EnumValue. * * Likely values: * @arg @c kGTLRServiceConsumerManagement_Method_Syntax_SyntaxEditions Syntax @@ -3049,7 +3080,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa * @arg @c kGTLRServiceConsumerManagement_Method_Syntax_SyntaxProto3 Syntax * `proto3`. (Value: "SYNTAX_PROTO3") */ -@property(nonatomic, copy, nullable) NSString *syntax; +@property(nonatomic, copy, nullable) NSString *syntax GTLR_DEPRECATED; @end @@ -3774,7 +3805,9 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * enumeration, etc. New usages of this message as an alternative to + * FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, + * ServiceOptions, or MethodOptions are strongly discouraged. */ @interface GTLRServiceConsumerManagement_Option : GTLRObject @@ -4706,7 +4739,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceConsumerManagement_V1GenerateDefa /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative + * to DescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceConsumerManagement_Type : GTLRObject diff --git a/Sources/GeneratedServices/ServiceDirectory/Public/GoogleAPIClientForREST/GTLRServiceDirectoryQuery.h b/Sources/GeneratedServices/ServiceDirectory/Public/GoogleAPIClientForREST/GTLRServiceDirectoryQuery.h index bd2200cd1..9eb5bea72 100644 --- a/Sources/GeneratedServices/ServiceDirectory/Public/GoogleAPIClientForREST/GTLRServiceDirectoryQuery.h +++ b/Sources/GeneratedServices/ServiceDirectory/Public/GoogleAPIClientForREST/GTLRServiceDirectoryQuery.h @@ -71,8 +71,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRServiceDirectoryQuery_ProjectsLocationsList : GTLRServiceDirectoryQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/ServiceManagement/GTLRServiceManagementObjects.m b/Sources/GeneratedServices/ServiceManagement/GTLRServiceManagementObjects.m index c11d53231..0604c1443 100644 --- a/Sources/GeneratedServices/ServiceManagement/GTLRServiceManagementObjects.m +++ b/Sources/GeneratedServices/ServiceManagement/GTLRServiceManagementObjects.m @@ -216,7 +216,8 @@ @implementation GTLRServiceManagement_Advice // @implementation GTLRServiceManagement_Api -@dynamic methods, mixins, name, options, sourceContext, syntax, version; +@dynamic edition, methods, mixins, name, options, sourceContext, syntax, + version; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -1342,8 +1343,8 @@ @implementation GTLRServiceManagement_ManagedService // @implementation GTLRServiceManagement_Method -@dynamic name, options, requestStreaming, requestTypeUrl, responseStreaming, - responseTypeUrl, syntax; +@dynamic edition, name, options, requestStreaming, requestTypeUrl, + responseStreaming, responseTypeUrl, syntax; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -1662,7 +1663,7 @@ @implementation GTLRServiceManagement_Page // @implementation GTLRServiceManagement_PhpSettings -@dynamic common; +@dynamic common, libraryPackage; @end @@ -1788,7 +1789,7 @@ @implementation GTLRServiceManagement_ResourceReference @implementation GTLRServiceManagement_Rollout @dynamic createdBy, createTime, deleteServiceStrategy, rolloutId, serviceName, - status, trafficPercentStrategy, universe; + status, trafficPercentStrategy; @end diff --git a/Sources/GeneratedServices/ServiceManagement/Public/GoogleAPIClientForREST/GTLRServiceManagementObjects.h b/Sources/GeneratedServices/ServiceManagement/Public/GoogleAPIClientForREST/GTLRServiceManagementObjects.h index 032fcb47e..1539f5bbc 100644 --- a/Sources/GeneratedServices/ServiceManagement/Public/GoogleAPIClientForREST/GTLRServiceManagementObjects.h +++ b/Sources/GeneratedServices/ServiceManagement/Public/GoogleAPIClientForREST/GTLRServiceManagementObjects.h @@ -1106,7 +1106,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Step_Status_InProgress */ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Step_Status_NotStarted; /** - * Unspecifed code. + * Unspecified code. * * Value: "STATUS_UNSPECIFIED" */ @@ -1159,10 +1159,17 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt * opposed to simply a description of methods and bindings. They are also * sometimes simply referred to as "APIs" in other contexts, such as the name * of this message itself. See https://cloud.google.com/apis/design/glossary - * for detailed terminology. + * for detailed terminology. New usages of this message as an alternative to + * ServiceDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceManagement_Api : GTLRObject +/** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */ +@property(nonatomic, copy, nullable) NSString *edition; + /** The methods of this interface, in unspecified order. */ @property(nonatomic, strong, nullable) NSArray *methods; @@ -1551,7 +1558,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt @property(nonatomic, strong, nullable) GTLRServiceManagement_BackendRule_OverridesByRequestProtocol *overridesByRequestProtocol; /** - * pathTranslation + * no-lint * * Likely values: * @arg @c kGTLRServiceManagement_BackendRule_PathTranslation_AppendPathToAddress @@ -2597,7 +2604,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to + * EnumDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceManagement_Enum : GTLRObject @@ -2633,7 +2644,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to + * EnumValueDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceManagement_EnumValue : GTLRObject @@ -2742,7 +2757,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an + * alternative to FieldDescriptorProto are strongly discouraged. This message + * does not reliability preserve all information necessary to model the schema + * and preserve semantics. Instead make use of FileDescriptorSet which + * preserves the necessary information. */ @interface GTLRServiceManagement_Field : GTLRObject @@ -3033,7 +3052,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** * Map of service names to renamed services. Keys are the package relative * service names and values are the name to be used for the service client and - * call options. publishing: go_settings: renamed_services: Publisher: + * call options. Example: publishing: go_settings: renamed_services: Publisher: * TopicAdmin */ @property(nonatomic, strong, nullable) GTLRServiceManagement_GoSettings_RenamedServices *renamedServices; @@ -3044,7 +3063,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** * Map of service names to renamed services. Keys are the package relative * service names and values are the name to be used for the service client and - * call options. publishing: go_settings: renamed_services: Publisher: + * call options. Example: publishing: go_settings: renamed_services: Publisher: * TopicAdmin * * @note This class is documented as having more properties of NSString. Use @c @@ -3640,10 +3659,21 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** - * Method represents a method of an API interface. + * Method represents a method of an API interface. New usages of this message + * as an alternative to MethodDescriptorProto are strongly discouraged. This + * message does not reliability preserve all information necessary to model the + * schema and preserve semantics. Instead make use of FileDescriptorSet which + * preserves the necessary information. */ @interface GTLRServiceManagement_Method : GTLRObject +/** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This + * field should be ignored, instead the edition should be inherited from Api. + * This is similar to Field and EnumValue. + */ +@property(nonatomic, copy, nullable) NSString *edition GTLR_DEPRECATED; + /** The simple name of this method. */ @property(nonatomic, copy, nullable) NSString *name; @@ -3671,7 +3701,8 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt @property(nonatomic, copy, nullable) NSString *responseTypeUrl; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the + * syntax should be inherited from Api. This is similar to Field and EnumValue. * * Likely values: * @arg @c kGTLRServiceManagement_Method_Syntax_SyntaxEditions Syntax @@ -3681,7 +3712,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt * @arg @c kGTLRServiceManagement_Method_Syntax_SyntaxProto3 Syntax `proto3`. * (Value: "SYNTAX_PROTO3") */ -@property(nonatomic, copy, nullable) NSString *syntax; +@property(nonatomic, copy, nullable) NSString *syntax GTLR_DEPRECATED; @end @@ -4460,7 +4491,9 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * enumeration, etc. New usages of this message as an alternative to + * FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, + * ServiceOptions, or MethodOptions are strongly discouraged. */ @interface GTLRServiceManagement_Option : GTLRObject @@ -4539,6 +4572,16 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** Some settings. */ @property(nonatomic, strong, nullable) GTLRServiceManagement_CommonLanguageSettings *common; +/** + * The package name to use in Php. Clobbers the php_namespace option set in the + * protobuf. This should be used **only** by APIs who have already set the + * language_settings.php.package_name" field in gapic.yaml. API teams should + * use the protobuf php_namespace option where possible. Example of a YAML + * configuration:: publishing: library_settings: php_settings: library_package: + * Google\\Cloud\\PubSub\\V1 + */ +@property(nonatomic, copy, nullable) NSString *libraryPackage; + @end @@ -4982,9 +5025,6 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt */ @property(nonatomic, strong, nullable) GTLRServiceManagement_TrafficPercentStrategy *trafficPercentStrategy; -/** The TPC universe which the rollout will be rolled out to. */ -@property(nonatomic, copy, nullable) NSString *universe; - @end @@ -5329,7 +5369,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt * step is in progress. (Value: "IN_PROGRESS") * @arg @c kGTLRServiceManagement_Step_Status_NotStarted The operation or * step has not started yet. (Value: "NOT_STARTED") - * @arg @c kGTLRServiceManagement_Step_Status_StatusUnspecified Unspecifed + * @arg @c kGTLRServiceManagement_Step_Status_StatusUnspecified Unspecified * code. (Value: "STATUS_UNSPECIFIED") */ @property(nonatomic, copy, nullable) NSString *status; @@ -5511,7 +5551,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceManagement_Type_Syntax_SyntaxProt /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative + * to DescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceManagement_Type : GTLRObject diff --git a/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingObjects.m b/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingObjects.m index a6f18a30d..ae01aa09e 100644 --- a/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingObjects.m +++ b/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingObjects.m @@ -1279,11 +1279,12 @@ @implementation GTLRServiceNetworking_ListDnsZonesResponse // @implementation GTLRServiceNetworking_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRServiceNetworking_Operation class] + @"operations" : [GTLRServiceNetworking_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingQuery.m b/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingQuery.m index 1ab26fb29..48a468832 100644 --- a/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingQuery.m +++ b/Sources/GeneratedServices/ServiceNetworking/GTLRServiceNetworkingQuery.m @@ -84,7 +84,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRServiceNetworkingQuery_OperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingObjects.h b/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingObjects.h index 9e6511035..b72bda249 100644 --- a/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingObjects.h +++ b/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingObjects.h @@ -3558,6 +3558,13 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceNetworking_ValidateConsumerConfig */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingQuery.h b/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingQuery.h index 2cd79560b..c4cd9d3c3 100644 --- a/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingQuery.h +++ b/Sources/GeneratedServices/ServiceNetworking/Public/GoogleAPIClientForREST/GTLRServiceNetworkingQuery.h @@ -168,6 +168,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRServiceNetworking_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/ServiceUsage/GTLRServiceUsageObjects.m b/Sources/GeneratedServices/ServiceUsage/GTLRServiceUsageObjects.m index c7cf9d960..264a04674 100644 --- a/Sources/GeneratedServices/ServiceUsage/GTLRServiceUsageObjects.m +++ b/Sources/GeneratedServices/ServiceUsage/GTLRServiceUsageObjects.m @@ -311,7 +311,8 @@ @implementation GTLRServiceUsage_AnalyzeConsumerPolicyResponse // @implementation GTLRServiceUsage_Api -@dynamic methods, mixins, name, options, sourceContext, syntax, version; +@dynamic edition, methods, mixins, name, options, sourceContext, syntax, + version; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -712,6 +713,34 @@ + (Class)classForAdditionalProperties { @end +// ---------------------------------------------------------------------------- +// +// GTLRServiceUsage_ContentSecurity +// + +@implementation GTLRServiceUsage_ContentSecurity +@dynamic contentSecurityProviders; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"contentSecurityProviders" : [GTLRServiceUsage_ContentSecurityProvider class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRServiceUsage_ContentSecurityProvider +// + +@implementation GTLRServiceUsage_ContentSecurityProvider +@dynamic name; +@end + + // ---------------------------------------------------------------------------- // // GTLRServiceUsage_Context @@ -1410,7 +1439,7 @@ @implementation GTLRServiceUsage_GoogleApiServiceusageV2betaEnableRule // @implementation GTLRServiceUsage_GoogleApiServiceusageV2betaImpact -@dynamic detail, impactType; +@dynamic detail, impactType, missingDependency; @end @@ -1741,14 +1770,64 @@ @implementation GTLRServiceUsage_LongRunning @end +// ---------------------------------------------------------------------------- +// +// GTLRServiceUsage_McpEnableRule +// + +@implementation GTLRServiceUsage_McpEnableRule +@dynamic mcpServices; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"mcpServices" : [GTLRServiceUsage_McpService class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRServiceUsage_McpPolicy +// + +@implementation GTLRServiceUsage_McpPolicy +@dynamic contentSecurity, createTime, ETag, mcpEnableRules, name, updateTime; + ++ (NSDictionary *)propertyToJSONKeyMap { + return @{ @"ETag" : @"etag" }; +} + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"mcpEnableRules" : [GTLRServiceUsage_McpEnableRule class] + }; + return map; +} + +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRServiceUsage_McpService +// + +@implementation GTLRServiceUsage_McpService +@dynamic service; +@end + + // ---------------------------------------------------------------------------- // // GTLRServiceUsage_Method // @implementation GTLRServiceUsage_Method -@dynamic name, options, requestStreaming, requestTypeUrl, responseStreaming, - responseTypeUrl, syntax; +@dynamic edition, name, options, requestStreaming, requestTypeUrl, + responseStreaming, responseTypeUrl, syntax; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -2389,6 +2468,15 @@ @implementation GTLRServiceUsage_UpdateConsumerPolicyMetadata @end +// ---------------------------------------------------------------------------- +// +// GTLRServiceUsage_UpdateMcpPolicyMetadata +// + +@implementation GTLRServiceUsage_UpdateMcpPolicyMetadata +@end + + // ---------------------------------------------------------------------------- // // GTLRServiceUsage_Usage diff --git a/Sources/GeneratedServices/ServiceUsage/Public/GoogleAPIClientForREST/GTLRServiceUsageObjects.h b/Sources/GeneratedServices/ServiceUsage/Public/GoogleAPIClientForREST/GTLRServiceUsageObjects.h index 90f26938e..1c3d6b86d 100644 --- a/Sources/GeneratedServices/ServiceUsage/Public/GoogleAPIClientForREST/GTLRServiceUsageObjects.h +++ b/Sources/GeneratedServices/ServiceUsage/Public/GoogleAPIClientForREST/GTLRServiceUsageObjects.h @@ -38,6 +38,8 @@ @class GTLRServiceUsage_ClientLibrarySettings; @class GTLRServiceUsage_CommonLanguageSettings; @class GTLRServiceUsage_ConsumerPolicy_Annotations; +@class GTLRServiceUsage_ContentSecurity; +@class GTLRServiceUsage_ContentSecurityProvider; @class GTLRServiceUsage_Context; @class GTLRServiceUsage_ContextRule; @class GTLRServiceUsage_Control; @@ -81,6 +83,8 @@ @class GTLRServiceUsage_Logging; @class GTLRServiceUsage_LoggingDestination; @class GTLRServiceUsage_LongRunning; +@class GTLRServiceUsage_McpEnableRule; +@class GTLRServiceUsage_McpService; @class GTLRServiceUsage_Method; @class GTLRServiceUsage_MethodPolicy; @class GTLRServiceUsage_MethodSettings; @@ -1321,10 +1325,17 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; * opposed to simply a description of methods and bindings. They are also * sometimes simply referred to as "APIs" in other contexts, such as the name * of this message itself. See https://cloud.google.com/apis/design/glossary - * for detailed terminology. + * for detailed terminology. New usages of this message as an alternative to + * ServiceDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceUsage_Api : GTLRObject +/** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */ +@property(nonatomic, copy, nullable) NSString *edition; + /** The methods of this interface, in unspecified order. */ @property(nonatomic, strong, nullable) NSArray *methods; @@ -1647,7 +1658,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; @property(nonatomic, strong, nullable) GTLRServiceUsage_BackendRule_OverridesByRequestProtocol *overridesByRequestProtocol; /** - * pathTranslation + * no-lint * * Likely values: * @arg @c kGTLRServiceUsage_BackendRule_PathTranslation_AppendPathToAddress @@ -2132,6 +2143,36 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; @end +/** + * ContentSecurity defines the content security related fields of a MCP policy. + */ +@interface GTLRServiceUsage_ContentSecurity : GTLRObject + +/** + * List of content security providers that are enabled for content scanning. + */ +@property(nonatomic, strong, nullable) NSArray *contentSecurityProviders; + +@end + + +/** + * ContentSecurityProvider contains the name of content security provider. + */ +@interface GTLRServiceUsage_ContentSecurityProvider : GTLRObject + +/** + * Name of security service for content scanning, such as Google Cloud Model + * Armor or supported third-party ISV solutions. If it is Google 1P service, + * the name should be prefixed with `services/`. If it is a 3P service, the + * format needs to be documented. The currently supported values are: - + * `services/modelarmor.googleapis.com` for Google Cloud Model Armor. + */ +@property(nonatomic, copy, nullable) NSString *name; + +@end + + /** * `Context` defines which contexts an API requests. Example: context: rules: - * selector: "*" requested: - google.rpc.context.ProjectContext - @@ -2697,7 +2738,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** - * Enum type definition. + * Enum type definition. New usages of this message as an alternative to + * EnumDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceUsage_Enum : GTLRObject @@ -2733,7 +2778,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** - * Enum value definition. + * Enum value definition. New usages of this message as an alternative to + * EnumValueDescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceUsage_EnumValue : GTLRObject @@ -2793,7 +2842,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** - * A single field of a message type. + * A single field of a message type. New usages of this message as an + * alternative to FieldDescriptorProto are strongly discouraged. This message + * does not reliability preserve all information necessary to model the schema + * and preserve semantics. Instead make use of FileDescriptorSet which + * preserves the necessary information. */ @interface GTLRServiceUsage_Field : GTLRObject @@ -3492,8 +3545,8 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; @property(nonatomic, strong, nullable) NSArray *enableRules; /** - * Output only. An opaque tag indicating the current version of the policy, - * used for concurrency control. + * An opaque tag indicating the current version of the policy, used for + * concurrency control. */ @property(nonatomic, copy, nullable) NSString *ETag; @@ -3564,6 +3617,14 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; */ @property(nonatomic, copy, nullable) NSString *impactType; +/** + * Output only. This field will be populated only for the + * `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: + * `services/compute.googleapis.com`. Impact.detail will be in format : + * `missing service dependency: {missing_dependency}.` + */ +@property(nonatomic, copy, nullable) NSString *missingDependency; + @end @@ -3585,7 +3646,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** * Map of service names to renamed services. Keys are the package relative * service names and values are the name to be used for the service client and - * call options. publishing: go_settings: renamed_services: Publisher: + * call options. Example: publishing: go_settings: renamed_services: Publisher: * TopicAdmin */ @property(nonatomic, strong, nullable) GTLRServiceUsage_GoSettings_RenamedServices *renamedServices; @@ -3596,7 +3657,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** * Map of service names to renamed services. Keys are the package relative * service names and values are the name to be used for the service client and - * call options. publishing: go_settings: renamed_services: Publisher: + * call options. Example: publishing: go_settings: renamed_services: Publisher: * TopicAdmin * * @note This class is documented as having more properties of NSString. Use @c @@ -4229,10 +4290,89 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** - * Method represents a method of an API interface. + * McpEnableRule contains MCP enablement related rules. + */ +@interface GTLRServiceUsage_McpEnableRule : GTLRObject + +/** List of enabled MCP services. */ +@property(nonatomic, strong, nullable) NSArray *mcpServices; + +@end + + +/** + * MCP Consumer Policy is a set of rules that define MCP related policy for a + * cloud resource hierarchy. + */ +@interface GTLRServiceUsage_McpPolicy : GTLRObject + +/** + * ContentSecurity contains the content security related fields of a MCP + * policy. + */ +@property(nonatomic, strong, nullable) GTLRServiceUsage_ContentSecurity *contentSecurity; + +/** + * Output only. The time the policy was created. For singleton policies (such + * as the `default` policy), this is the first touch of the policy. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *createTime; + +/** + * An opaque tag indicating the current version of the policy, used for + * concurrency control. + */ +@property(nonatomic, copy, nullable) NSString *ETag; + +/** McpEnableRules contains MCP enablement related rules. */ +@property(nonatomic, strong, nullable) NSArray *mcpEnableRules; + +/** + * Output only. The resource name of the policy. Only the `default` policy is + * supported. We allow the following formats: + * `projects/{PROJECT_NUMBER}/mcpPolicies/default`, + * `projects/{PROJECT_ID}/mcpPolicies/default`, + * `folders/{FOLDER_ID}/mcpPolicies/default`, + * `organizations/{ORG_ID}/mcpPolicies/default`. + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** Output only. The time the policy was last updated. */ +@property(nonatomic, strong, nullable) GTLRDateTime *updateTime; + +@end + + +/** + * McpService contains the service names that are enabled for MCP. + */ +@interface GTLRServiceUsage_McpService : GTLRObject + +/** + * The names of the services that are enabled for MCP. Example: + * `services/library-example.googleapis.com` + */ +@property(nonatomic, copy, nullable) NSString *service; + +@end + + +/** + * Method represents a method of an API interface. New usages of this message + * as an alternative to MethodDescriptorProto are strongly discouraged. This + * message does not reliability preserve all information necessary to model the + * schema and preserve semantics. Instead make use of FileDescriptorSet which + * preserves the necessary information. */ @interface GTLRServiceUsage_Method : GTLRObject +/** + * The source edition string, only valid when syntax is SYNTAX_EDITIONS. This + * field should be ignored, instead the edition should be inherited from Api. + * This is similar to Field and EnumValue. + */ +@property(nonatomic, copy, nullable) NSString *edition GTLR_DEPRECATED; + /** The simple name of this method. */ @property(nonatomic, copy, nullable) NSString *name; @@ -4260,7 +4400,8 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; @property(nonatomic, copy, nullable) NSString *responseTypeUrl; /** - * The source syntax of this method. + * The source syntax of this method. This field should be ignored, instead the + * syntax should be inherited from Api. This is similar to Field and EnumValue. * * Likely values: * @arg @c kGTLRServiceUsage_Method_Syntax_SyntaxEditions Syntax `editions`. @@ -4270,7 +4411,7 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; * @arg @c kGTLRServiceUsage_Method_Syntax_SyntaxProto3 Syntax `proto3`. * (Value: "SYNTAX_PROTO3") */ -@property(nonatomic, copy, nullable) NSString *syntax; +@property(nonatomic, copy, nullable) NSString *syntax GTLR_DEPRECATED; @end @@ -5008,7 +5149,9 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** * A protocol buffer option, which can be attached to a message, field, - * enumeration, etc. + * enumeration, etc. New usages of this message as an alternative to + * FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, + * ServiceOptions, or MethodOptions are strongly discouraged. */ @interface GTLRServiceUsage_Option : GTLRObject @@ -5691,7 +5834,11 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; /** - * A protocol buffer message type. + * A protocol buffer message type. New usages of this message as an alternative + * to DescriptorProto are strongly discouraged. This message does not + * reliability preserve all information necessary to model the schema and + * preserve semantics. Instead make use of FileDescriptorSet which preserves + * the necessary information. */ @interface GTLRServiceUsage_Type : GTLRObject @@ -5745,6 +5892,13 @@ FOUNDATION_EXTERN NSString * const kGTLRServiceUsage_Type_Syntax_SyntaxProto3; @end +/** + * Metadata for the `UpdateMcpPolicy` method. + */ +@interface GTLRServiceUsage_UpdateMcpPolicyMetadata : GTLRObject +@end + + /** * Configuration controlling usage of a service. */ diff --git a/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentObjects.m b/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentObjects.m index 123cddf71..16c22c66a 100644 --- a/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentObjects.m +++ b/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentObjects.m @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ diff --git a/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentQuery.m b/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentQuery.m index 40023a069..c442476f5 100644 --- a/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentQuery.m +++ b/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentQuery.m @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ diff --git a/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentService.m b/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentService.m index ac29cac6e..58092b381 100644 --- a/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentService.m +++ b/Sources/GeneratedServices/ShoppingContent/GTLRShoppingContentService.m @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ diff --git a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContent.h b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContent.h index 46055c26b..5459d2a0a 100644 --- a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContent.h +++ b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContent.h @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ diff --git a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentObjects.h b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentObjects.h index 4f5377659..8f62757f0 100644 --- a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentObjects.h +++ b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentObjects.h @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ diff --git a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentQuery.h b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentQuery.h index ad9db5ea2..c1f57585a 100644 --- a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentQuery.h +++ b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentQuery.h @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ diff --git a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentService.h b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentService.h index b9b6e07e5..ea6c29397 100644 --- a/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentService.h +++ b/Sources/GeneratedServices/ShoppingContent/Public/GoogleAPIClientForREST/GTLRShoppingContentService.h @@ -4,7 +4,8 @@ // API: // Content API for Shopping (content/v2.1) // Description: -// Manage your product listings and accounts for Google Shopping +// This API is deprecated. Please use Merchant API instead: +// https://developers.google.com/merchant/api. // Documentation: // https://developers.google.com/shopping-content/v2/ @@ -39,7 +40,8 @@ FOUNDATION_EXTERN NSString * const kGTLRAuthScopeShoppingContent; /** * Service for executing Content API for Shopping queries. * - * Manage your product listings and accounts for Google Shopping + * This API is deprecated. Please use Merchant API instead: + * https://developers.google.com/merchant/api. */ @interface GTLRShoppingContentService : GTLRService diff --git a/Sources/GeneratedServices/Spanner/GTLRSpannerObjects.m b/Sources/GeneratedServices/Spanner/GTLRSpannerObjects.m index 9f6cbae6e..7713742fb 100644 --- a/Sources/GeneratedServices/Spanner/GTLRSpannerObjects.m +++ b/Sources/GeneratedServices/Spanner/GTLRSpannerObjects.m @@ -290,7 +290,7 @@ + (Class)classForAdditionalProperties { // @implementation GTLRSpanner_AdaptMessageResponse -@dynamic payload, stateUpdates; +@dynamic last, payload, stateUpdates; @end @@ -633,7 +633,7 @@ @implementation GTLRSpanner_CommitRequest // @implementation GTLRSpanner_CommitResponse -@dynamic commitStats, commitTimestamp, precommitToken; +@dynamic commitStats, commitTimestamp, precommitToken, snapshotTimestamp; @end diff --git a/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerObjects.h b/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerObjects.h index dbdd91792..db8a5858c 100644 --- a/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerObjects.h +++ b/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerObjects.h @@ -243,7 +243,7 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_ContextValue_Severity_Warning; /** * Use customer managed encryption. If specified, either `kms_key_name` or - * `kms_key_names` must contain valid Cloud KMS key(s). + * `kms_key_names` must contain valid Cloud KMS keys. * * Value: "CUSTOMER_MANAGED_ENCRYPTION" */ @@ -1450,6 +1450,15 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni */ @interface GTLRSpanner_AdaptMessageResponse : GTLRObject +/** + * Optional. Indicates whether this is the last AdaptMessageResponse in the + * stream. This field may be optionally set by the server. Clients should not + * rely on this field being set in all cases. + * + * Uses NSNumber of boolValue. + */ +@property(nonatomic, strong, nullable) NSNumber *last; + /** * Optional. Uninterpreted bytes from the underlying wire protocol. * @@ -1748,9 +1757,9 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @property(nonatomic, copy, nullable) NSString *incrementalBackupChainId; /** - * Output only. The instance partition(s) storing the backup. This is the same - * as the list of the instance partition(s) that the database had footprint in - * at the backup's `version_time`. + * Output only. The instance partition storing the backup. This is the same as + * the list of the instance partitions that the database recorded at the + * backup's `version_time`. */ @property(nonatomic, strong, nullable) NSArray *instancePartitions; @@ -2357,6 +2366,14 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni */ @property(nonatomic, strong, nullable) GTLRSpanner_MultiplexedSessionPrecommitToken *precommitToken; +/** + * If `TransactionOptions.isolation_level` is set to + * `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the + * timestamp at which all reads in the transaction ran. This timestamp is never + * returned. + */ +@property(nonatomic, strong, nullable) GTLRDateTime *snapshotTimestamp; + @end @@ -2431,7 +2448,7 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni * Likely values: * @arg @c kGTLRSpanner_CopyBackupEncryptionConfig_EncryptionType_CustomerManagedEncryption * Use customer managed encryption. If specified, either `kms_key_name` - * or `kms_key_names` must contain valid Cloud KMS key(s). (Value: + * or `kms_key_names` must contain valid Cloud KMS keys. (Value: * "CUSTOMER_MANAGED_ENCRYPTION") * @arg @c kGTLRSpanner_CopyBackupEncryptionConfig_EncryptionType_EncryptionTypeUnspecified * Unspecified. Do not use. (Value: "ENCRYPTION_TYPE_UNSPECIFIED") @@ -2447,8 +2464,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @property(nonatomic, copy, nullable) NSString *encryptionType; /** - * Optional. The Cloud KMS key that will be used to protect the backup. This - * field should be set only when encryption_type is + * Optional. This field is maintained for backwards compatibility. For new + * callers, we recommend using `kms_key_names` to specify the KMS key. Only use + * `kms_key_name` if the location of the KMS key matches the database + * instance's configuration (location) exactly. For example, if the KMS + * location is in `us-central1` or `nam3`, then the database instance must also + * be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + * decrypt the restored database. Set this field only when encryption_type is * `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. */ @@ -2575,8 +2597,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @property(nonatomic, copy, nullable) NSString *encryptionType; /** - * Optional. The Cloud KMS key that will be used to protect the backup. This - * field should be set only when encryption_type is + * Optional. This field is maintained for backwards compatibility. For new + * callers, we recommend using `kms_key_names` to specify the KMS key. Only use + * `kms_key_name` if the location of the KMS key matches the database + * instance's configuration (location) exactly. For example, if the KMS + * location is in `us-central1` or `nam3`, then the database instance must also + * be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + * decrypt the restored database. Set this field only when encryption_type is * `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. */ @@ -3224,13 +3251,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @interface GTLRSpanner_DdlStatementActionInfo : GTLRObject /** - * The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This - * field is a non-empty string. + * The action for the DDL statement, for example, CREATE, ALTER, DROP, GRANT, + * etc. This field is a non-empty string. */ @property(nonatomic, copy, nullable) NSString *action; /** - * The entity name(s) being operated on the DDL statement. E.g. 1. For + * The entity names being operated on the DDL statement. For example, 1. For * statement "CREATE TABLE t1(...)", `entity_names` = ["t1"]. 2. For statement * "GRANT ROLE r1, r2 ...", `entity_names` = ["r1", "r2"]. 3. For statement * "ANALYZE", `entity_names` = []. @@ -3238,9 +3265,9 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @property(nonatomic, strong, nullable) NSArray *entityNames; /** - * The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This - * field can be empty string for some DDL statement, e.g. for statement - * "ANALYZE", `entity_type` = "". + * The entity type for the DDL statement, for example, TABLE, INDEX, VIEW, etc. + * This field can be empty string for some DDL statement, for example, for + * statement "ANALYZE", `entity_type` = "". */ @property(nonatomic, copy, nullable) NSString *entityType; @@ -4460,12 +4487,12 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni /** * Optional. This field is maintained for backwards compatibility. For new - * callers, we recommend using `kms_key_names` to specify the KMS key. - * `kms_key_name` should only be used if the location of the KMS key matches - * the database instance’s configuration (location) exactly. E.g. The KMS - * location is in us-central1 or nam3 and the database instance is also in - * us-central1 or nam3. The Cloud KMS key to be used for encrypting and - * decrypting the database. Values are of the form + * callers, we recommend using `kms_key_names` to specify the KMS key. Only use + * `kms_key_name` if the location of the KMS key matches the database + * instance's configuration (location) exactly. For example, if the KMS + * location is in `us-central1` or `nam3`, then the database instance must also + * be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + * decrypt the restored database. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. */ @property(nonatomic, copy, nullable) NSString *kmsKeyName; @@ -4626,7 +4653,9 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni */ @interface GTLRSpanner_InstanceReplicaSelection : GTLRObject -/** Required. Name of the location of the replicas (e.g., "us-central1"). */ +/** + * Required. Name of the location of the replicas (for example, "us-central1"). + */ @property(nonatomic, copy, nullable) NSString *location; @end @@ -6987,8 +7016,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @property(nonatomic, copy, nullable) NSString *encryptionType; /** - * Optional. The Cloud KMS key that will be used to encrypt/decrypt the - * restored database. This field should be set only when encryption_type is + * Optional. This field is maintained for backwards compatibility. For new + * callers, we recommend using `kms_key_names` to specify the KMS key. Only use + * `kms_key_name` if the location of the KMS key matches the database + * instance's configuration (location) exactly. For example, if the KMS + * location is in `us-central1` or `nam3`, then the database instance must also + * be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + * decrypt the restored database. Set this field only when encryption_type is * `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. */ @@ -7452,8 +7486,8 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @interface GTLRSpanner_SingleRegionQuorum : GTLRObject /** - * Required. The location of the serving region, e.g. "us-central1". The - * location must be one of the regions within the dual-region instance + * Required. The location of the serving region, for example, "us-central1". + * The location must be one of the regions within the dual-region instance * configuration of your database. The list of valid locations is available * using the GetInstanceConfig API. This should only be used if you plan to * change quorum to the single-region quorum type. @@ -7944,9 +7978,9 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni @property(nonatomic, strong, nullable) NSArray *statements; /** - * Output only. When true, indicates that the operation is throttled e.g. due - * to resource constraints. When resources become available the operation will - * resume and this field will be false again. + * Output only. When true, indicates that the operation is throttled, for + * example, due to resource constraints. When resources become available the + * operation will resume and this field will be false again. * * Uses NSNumber of boolValue. */ @@ -7960,13 +7994,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpanner_VisualizationData_KeyUnit_KeyUni * necessarily all at once, to the database schema at some point (or points) in * the future. The server checks that the statements are executable * (syntactically valid, name tables that exist, etc.) before enqueueing them, - * but they may still fail upon later execution (e.g., if a statement from - * another batch of statements is applied first and it conflicts in some way, - * or if there is some data-related problem like a `NULL` value in a column to - * which `NOT NULL` would be added). If a statement fails, all subsequent - * statements in the batch are automatically cancelled. Each batch of - * statements is assigned a name which can be used with the Operations API to - * monitor progress. See the operation_id field for more details. + * but they may still fail upon later execution (for example, if a statement + * from another batch of statements is applied first and it conflicts in some + * way, or if there is some data-related problem like a `NULL` value in a + * column to which `NOT NULL` would be added). If a statement fails, all + * subsequent statements in the batch are automatically cancelled. Each batch + * of statements is assigned a name which can be used with the Operations API + * to monitor progress. See the operation_id field for more details. */ @interface GTLRSpanner_UpdateDatabaseDdlRequest : GTLRObject diff --git a/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerQuery.h b/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerQuery.h index c2a325ffc..658a69fda 100644 --- a/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerQuery.h +++ b/Sources/GeneratedServices/Spanner/Public/GoogleAPIClientForREST/GTLRSpannerQuery.h @@ -968,8 +968,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpannerViewViewUnspecified; @property(nonatomic, copy, nullable) NSString *encryptionConfigEncryptionType; /** - * Optional. The Cloud KMS key that will be used to protect the backup. This - * field should be set only when encryption_type is + * Optional. This field is maintained for backwards compatibility. For new + * callers, we recommend using `kms_key_names` to specify the KMS key. Only use + * `kms_key_name` if the location of the KMS key matches the database + * instance's configuration (location) exactly. For example, if the KMS + * location is in `us-central1` or `nam3`, then the database instance must also + * be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and + * decrypt the restored database. Set this field only when encryption_type is * `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form * `projects//locations//keyRings//cryptoKeys/`. */ @@ -993,10 +998,10 @@ FOUNDATION_EXTERN NSString * const kGTLRSpannerViewViewUnspecified; @property(nonatomic, strong, nullable) NSArray *encryptionConfigKmsKeyNames; /** - * Required. The name of the instance in which the backup will be created. This - * must be the same instance that contains the database the backup will be - * created from. The backup will be stored in the location(s) specified in the - * instance configuration of this instance. Values are of the form + * Required. The name of the instance in which the backup is created. This must + * be the same instance that contains the database the backup is created from. + * The backup will be stored in the locations specified in the instance + * configuration of this instance. Values are of the form * `projects//instances/`. */ @property(nonatomic, copy, nullable) NSString *parent; @@ -1014,9 +1019,9 @@ FOUNDATION_EXTERN NSString * const kGTLRSpannerViewViewUnspecified; * databases can run concurrently. * * @param object The @c GTLRSpanner_Backup to include in the query. - * @param parent Required. The name of the instance in which the backup will be + * @param parent Required. The name of the instance in which the backup is * created. This must be the same instance that contains the database the - * backup will be created from. The backup will be stored in the location(s) + * backup is created from. The backup will be stored in the locations * specified in the instance configuration of this instance. Values are of * the form `projects//instances/`. * @@ -1385,11 +1390,11 @@ FOUNDATION_EXTERN NSString * const kGTLRSpannerViewViewUnspecified; @property(nonatomic, copy, nullable) NSString *name; /** - * Required. A mask specifying which fields (e.g. `expire_time`) in the Backup - * resource should be updated. This mask is relative to the Backup resource, - * not to the request message. The field mask must always be specified; this - * prevents any future fields from being erased accidentally by clients that do - * not know about them. + * Required. A mask specifying which fields (for example, `expire_time`) in the + * backup resource should be updated. This mask is relative to the backup + * resource, not to the request message. The field mask must always be + * specified; this prevents any future fields from being erased accidentally by + * clients that do not know about them. * * String format is a comma-separated list of fields. */ @@ -3631,7 +3636,7 @@ FOUNDATION_EXTERN NSString * const kGTLRSpannerViewViewUnspecified; * Updates the schema of a Cloud Spanner database by creating/altering/dropping * tables, columns, indexes, etc. The returned long-running operation will have * a name of the format `/operations/` and can be used to track execution of - * the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. + * the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. * The operation has no response. * * Method: spanner.projects.instances.databases.updateDdl @@ -3651,7 +3656,7 @@ FOUNDATION_EXTERN NSString * const kGTLRSpannerViewViewUnspecified; * Updates the schema of a Cloud Spanner database by creating/altering/dropping * tables, columns, indexes, etc. The returned long-running operation will have * a name of the format `/operations/` and can be used to track execution of - * the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. + * the schema changes. The metadata field type is UpdateDatabaseDdlMetadata. * The operation has no response. * * @param object The @c GTLRSpanner_UpdateDatabaseDdlRequest to include in the diff --git a/Sources/GeneratedServices/Speech/GTLRSpeechObjects.m b/Sources/GeneratedServices/Speech/GTLRSpeechObjects.m index bc1f404f9..989def7ac 100644 --- a/Sources/GeneratedServices/Speech/GTLRSpeechObjects.m +++ b/Sources/GeneratedServices/Speech/GTLRSpeechObjects.m @@ -251,11 +251,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRSpeech_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRSpeech_Operation class] + @"operations" : [GTLRSpeech_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Speech/GTLRSpeechQuery.m b/Sources/GeneratedServices/Speech/GTLRSpeechQuery.m index ccc5f4307..b8f9e6189 100644 --- a/Sources/GeneratedServices/Speech/GTLRSpeechQuery.m +++ b/Sources/GeneratedServices/Speech/GTLRSpeechQuery.m @@ -37,7 +37,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRSpeechQuery_OperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)query { NSString *pathURITemplate = @"v1/operations"; diff --git a/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechObjects.h b/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechObjects.h index 57017069d..9c3eadbc4 100644 --- a/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechObjects.h +++ b/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechObjects.h @@ -702,6 +702,13 @@ FOUNDATION_EXTERN NSString * const kGTLRSpeech_RecognitionMetadata_RecordingDevi */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechQuery.h b/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechQuery.h index f92bd5bc1..dd8e3e91e 100644 --- a/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechQuery.h +++ b/Sources/GeneratedServices/Speech/Public/GoogleAPIClientForREST/GTLRSpeechQuery.h @@ -86,6 +86,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRSpeech_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Storage/GTLRStorageObjects.m b/Sources/GeneratedServices/Storage/GTLRStorageObjects.m index c218dbe82..114721572 100644 --- a/Sources/GeneratedServices/Storage/GTLRStorageObjects.m +++ b/Sources/GeneratedServices/Storage/GTLRStorageObjects.m @@ -503,11 +503,12 @@ @implementation GTLRStorage_BucketAccessControls // @implementation GTLRStorage_Buckets -@dynamic items, kind, nextPageToken; +@dynamic items, kind, nextPageToken, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"items" : [GTLRStorage_Bucket class] + @"items" : [GTLRStorage_Bucket class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/Storage/GTLRStorageQuery.m b/Sources/GeneratedServices/Storage/GTLRStorageQuery.m index 87cb179a8..df08b4f2c 100644 --- a/Sources/GeneratedServices/Storage/GTLRStorageQuery.m +++ b/Sources/GeneratedServices/Storage/GTLRStorageQuery.m @@ -479,8 +479,8 @@ + (instancetype)queryWithObject:(GTLRStorage_Bucket *)object @implementation GTLRStorageQuery_BucketsList -@dynamic maxResults, pageToken, prefix, project, projection, softDeleted, - userProject; +@dynamic maxResults, pageToken, prefix, project, projection, + returnPartialSuccess, softDeleted, userProject; + (instancetype)queryWithProject:(NSString *)project { NSString *pathURITemplate = @"b"; diff --git a/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageObjects.h b/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageObjects.h index 78f694786..154134b48 100644 --- a/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageObjects.h +++ b/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageObjects.h @@ -1297,6 +1297,12 @@ FOUNDATION_EXTERN NSString * const kGTLRStorage_Bucket_Encryption_GoogleManagedE */ @property(nonatomic, copy, nullable) NSString *nextPageToken; +/** + * The list of bucket resource names that could not be reached during the + * listing operation. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageQuery.h b/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageQuery.h index 5fab2c5cf..df2e99744 100644 --- a/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageQuery.h +++ b/Sources/GeneratedServices/Storage/Public/GoogleAPIClientForREST/GTLRStorageQuery.h @@ -995,6 +995,12 @@ FOUNDATION_EXTERN NSString * const kGTLRStorageProjectionNoAcl; */ @property(nonatomic, copy, nullable) NSString *projection; +/** + * If true, return a list of bucket resource names for buckets that are in + * unreachable locations. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * If true, only soft-deleted bucket versions will be returned. The default is * false. For more information, see [Soft diff --git a/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsObjects.m b/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsObjects.m index f9c691aee..bc971caff 100644 --- a/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsObjects.m +++ b/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsObjects.m @@ -252,11 +252,12 @@ + (NSString *)collectionItemsKey { // @implementation GTLRStorageBatchOperations_ListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRStorageBatchOperations_Operation class] + @"operations" : [GTLRStorageBatchOperations_Operation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsQuery.m b/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsQuery.m index e1fdaab75..af14a78db 100644 --- a/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsQuery.m +++ b/Sources/GeneratedServices/StorageBatchOperations/GTLRStorageBatchOperationsQuery.m @@ -237,7 +237,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRStorageBatchOperationsQuery_ProjectsLocationsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsObjects.h b/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsObjects.h index c1fa7d8ae..d1880c770 100644 --- a/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsObjects.h +++ b/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsObjects.h @@ -749,6 +749,13 @@ FOUNDATION_EXTERN NSString * const kGTLRStorageBatchOperations_PutObjectHold_Tem */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsQuery.h b/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsQuery.h index ce9f4c339..907b35ab6 100644 --- a/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsQuery.h +++ b/Sources/GeneratedServices/StorageBatchOperations/Public/GoogleAPIClientForREST/GTLRStorageBatchOperationsQuery.h @@ -256,8 +256,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRStorageBatchOperationsQuery_ProjectsLocationsList : GTLRStorageBatchOperationsQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; @@ -430,6 +430,17 @@ NS_ASSUME_NONNULL_BEGIN /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRStorageBatchOperations_ListOperationsResponse. * diff --git a/Sources/GeneratedServices/Texttospeech/GTLRTexttospeechObjects.m b/Sources/GeneratedServices/Texttospeech/GTLRTexttospeechObjects.m index 75633acca..ad5e0ee14 100644 --- a/Sources/GeneratedServices/Texttospeech/GTLRTexttospeechObjects.m +++ b/Sources/GeneratedServices/Texttospeech/GTLRTexttospeechObjects.m @@ -201,6 +201,34 @@ @implementation GTLRTexttospeech_MultiSpeakerMarkup @end +// ---------------------------------------------------------------------------- +// +// GTLRTexttospeech_MultispeakerPrebuiltVoice +// + +@implementation GTLRTexttospeech_MultispeakerPrebuiltVoice +@dynamic speakerAlias, speakerId; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRTexttospeech_MultiSpeakerVoiceConfig +// + +@implementation GTLRTexttospeech_MultiSpeakerVoiceConfig +@dynamic speakerVoiceConfigs; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"speakerVoiceConfigs" : [GTLRTexttospeech_MultispeakerPrebuiltVoice class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRTexttospeech_Operation @@ -365,5 +393,6 @@ @implementation GTLRTexttospeech_VoiceCloneParams // @implementation GTLRTexttospeech_VoiceSelectionParams -@dynamic customVoice, languageCode, modelName, name, ssmlGender, voiceClone; +@dynamic customVoice, languageCode, modelName, multiSpeakerVoiceConfig, name, + ssmlGender, voiceClone; @end diff --git a/Sources/GeneratedServices/Texttospeech/Public/GoogleAPIClientForREST/GTLRTexttospeechObjects.h b/Sources/GeneratedServices/Texttospeech/Public/GoogleAPIClientForREST/GTLRTexttospeechObjects.h index bf7eed216..08c9ac7fb 100644 --- a/Sources/GeneratedServices/Texttospeech/Public/GoogleAPIClientForREST/GTLRTexttospeechObjects.h +++ b/Sources/GeneratedServices/Texttospeech/Public/GoogleAPIClientForREST/GTLRTexttospeechObjects.h @@ -21,6 +21,8 @@ @class GTLRTexttospeech_CustomPronunciations; @class GTLRTexttospeech_CustomVoiceParams; @class GTLRTexttospeech_MultiSpeakerMarkup; +@class GTLRTexttospeech_MultispeakerPrebuiltVoice; +@class GTLRTexttospeech_MultiSpeakerVoiceConfig; @class GTLRTexttospeech_Operation; @class GTLRTexttospeech_Operation_Metadata; @class GTLRTexttospeech_Operation_Response; @@ -523,6 +525,43 @@ FOUNDATION_EXTERN NSString * const kGTLRTexttospeech_VoiceSelectionParams_SsmlGe @end +/** + * Configuration for a single speaker in a Gemini TTS multi-speaker setup. + * Enables dialogue between two speakers. + */ +@interface GTLRTexttospeech_MultispeakerPrebuiltVoice : GTLRObject + +/** + * Required. The speaker alias of the voice. This is the user-chosen speaker + * name that is used in the multispeaker text input, such as "Speaker1". + */ +@property(nonatomic, copy, nullable) NSString *speakerAlias; + +/** + * Required. The speaker ID of the voice. See + * https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for + * available values. + */ +@property(nonatomic, copy, nullable) NSString *speakerId; + +@end + + +/** + * Configuration for a multi-speaker text-to-speech setup. Enables the use of + * up to two distinct voices in a single synthesis request. + */ +@interface GTLRTexttospeech_MultiSpeakerVoiceConfig : GTLRObject + +/** + * Required. A list of configurations for the voices of the speakers. Exactly + * two speaker voice configurations must be provided. + */ +@property(nonatomic, strong, nullable) NSArray *speakerVoiceConfigs; + +@end + + /** * This resource represents a long-running operation that is the result of a * network API call. @@ -679,9 +718,10 @@ FOUNDATION_EXTERN NSString * const kGTLRTexttospeech_VoiceSelectionParams_SsmlGe @property(nonatomic, strong, nullable) GTLRTexttospeech_MultiSpeakerMarkup *multiSpeakerMarkup; /** - * This is system instruction supported only for controllable voice models. If - * used, we will pass text to Flash TTS as is. Can only used with Flash TTS. - * What AI Studio calls Style Instructions. + * This system instruction is supported only for controllable/promptable voice + * models. If this system instruction is used, we pass the unedited text to + * Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls + * this system instruction, Style Instructions. */ @property(nonatomic, copy, nullable) NSString *prompt; @@ -890,6 +930,12 @@ FOUNDATION_EXTERN NSString * const kGTLRTexttospeech_VoiceSelectionParams_SsmlGe */ @property(nonatomic, copy, nullable) NSString *modelName; +/** + * Optional. The configuration for a Gemini multi-speaker text-to-speech setup. + * Enables the use of two distinct voices in a single synthesis request. + */ +@property(nonatomic, strong, nullable) GTLRTexttospeech_MultiSpeakerVoiceConfig *multiSpeakerVoiceConfig; + /** * The name of the voice. If both the name and the gender are not set, the * service will choose a voice based on the other parameters such as diff --git a/Sources/GeneratedServices/TrafficDirectorService/Public/GoogleAPIClientForREST/GTLRTrafficDirectorServiceObjects.h b/Sources/GeneratedServices/TrafficDirectorService/Public/GoogleAPIClientForREST/GTLRTrafficDirectorServiceObjects.h index e6996064d..208e23608 100644 --- a/Sources/GeneratedServices/TrafficDirectorService/Public/GoogleAPIClientForREST/GTLRTrafficDirectorServiceObjects.h +++ b/Sources/GeneratedServices/TrafficDirectorService/Public/GoogleAPIClientForREST/GTLRTrafficDirectorServiceObjects.h @@ -2156,9 +2156,9 @@ FOUNDATION_EXTERN NSString * const kGTLRTrafficDirectorService_SocketAddress_Pro /** - * Specifies the way to match a ProtobufWkt::Value. Primitive values and - * ListValue are supported. StructValue is not supported and is always not - * matched. [#next-free-field: 8] + * Specifies the way to match a Protobuf::Value. Primitive values and ListValue + * are supported. StructValue is not supported and is always not matched. + * [#next-free-field: 8] */ @interface GTLRTrafficDirectorService_ValueMatcher : GTLRObject diff --git a/Sources/GeneratedServices/VMMigrationService/GTLRVMMigrationServiceObjects.m b/Sources/GeneratedServices/VMMigrationService/GTLRVMMigrationServiceObjects.m index 5a47e13a4..f23d5d355 100644 --- a/Sources/GeneratedServices/VMMigrationService/GTLRVMMigrationServiceObjects.m +++ b/Sources/GeneratedServices/VMMigrationService/GTLRVMMigrationServiceObjects.m @@ -357,6 +357,16 @@ @implementation GTLRVMMigrationService_AccessKeyCredentials @end +// ---------------------------------------------------------------------------- +// +// GTLRVMMigrationService_AdaptationModifier +// + +@implementation GTLRVMMigrationService_AdaptationModifier +@dynamic modifier, value; +@end + + // ---------------------------------------------------------------------------- // // GTLRVMMigrationService_AdaptingOSStep @@ -835,10 +845,10 @@ @implementation GTLRVMMigrationService_ComputeEngineDisksTargetDetails // @implementation GTLRVMMigrationService_ComputeEngineTargetDefaults -@dynamic additionalLicenses, appliedLicense, bootConversion, bootOption, - computeScheduling, diskReplicaZones, diskType, - enableIntegrityMonitoring, enableVtpm, encryption, hostname, labels, - licenseType, machineType, machineTypeSeries, metadata, +@dynamic adaptationModifiers, additionalLicenses, appliedLicense, + bootConversion, bootOption, computeScheduling, diskReplicaZones, + diskType, enableIntegrityMonitoring, enableVtpm, encryption, hostname, + labels, licenseType, machineType, machineTypeSeries, metadata, networkInterfaces, networkTags, secureBoot, serviceAccount, targetProject, vmName, zoneProperty; @@ -848,6 +858,7 @@ @implementation GTLRVMMigrationService_ComputeEngineTargetDefaults + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"adaptationModifiers" : [GTLRVMMigrationService_AdaptationModifier class], @"additionalLicenses" : [NSString class], @"diskReplicaZones" : [NSString class], @"networkInterfaces" : [GTLRVMMigrationService_NetworkInterface class], @@ -893,10 +904,10 @@ + (Class)classForAdditionalProperties { // @implementation GTLRVMMigrationService_ComputeEngineTargetDetails -@dynamic additionalLicenses, appliedLicense, bootConversion, bootOption, - computeScheduling, diskReplicaZones, diskType, - enableIntegrityMonitoring, enableVtpm, encryption, hostname, labels, - licenseType, machineType, machineTypeSeries, metadata, +@dynamic adaptationModifiers, additionalLicenses, appliedLicense, + bootConversion, bootOption, computeScheduling, diskReplicaZones, + diskType, enableIntegrityMonitoring, enableVtpm, encryption, hostname, + labels, licenseType, machineType, machineTypeSeries, metadata, networkInterfaces, networkTags, project, secureBoot, serviceAccount, vmName, zoneProperty; @@ -906,6 +917,7 @@ @implementation GTLRVMMigrationService_ComputeEngineTargetDetails + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ + @"adaptationModifiers" : [GTLRVMMigrationService_AdaptationModifier class], @"additionalLicenses" : [NSString class], @"diskReplicaZones" : [NSString class], @"networkInterfaces" : [GTLRVMMigrationService_NetworkInterface class], @@ -1398,7 +1410,15 @@ @implementation GTLRVMMigrationService_ImageImportJob // @implementation GTLRVMMigrationService_ImageImportOsAdaptationParameters -@dynamic bootConversion, generalize, licenseType; +@dynamic adaptationModifiers, bootConversion, generalize, licenseType; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"adaptationModifiers" : [GTLRVMMigrationService_AdaptationModifier class] + }; + return map; +} + @end diff --git a/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceObjects.h b/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceObjects.h index 96dd782b3..3b959f8cc 100644 --- a/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceObjects.h +++ b/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceObjects.h @@ -16,6 +16,7 @@ #endif @class GTLRVMMigrationService_AccessKeyCredentials; +@class GTLRVMMigrationService_AdaptationModifier; @class GTLRVMMigrationService_AdaptingOSStep; @class GTLRVMMigrationService_ApplianceVersion; @class GTLRVMMigrationService_AppliedLicense; @@ -1777,6 +1778,24 @@ FOUNDATION_EXTERN NSString * const kGTLRVMMigrationService_VmwareVmDetails_Power @end +/** + * AdaptationModifier a modifier to be used for configuration of the OS + * adaptation process. + */ +@interface GTLRVMMigrationService_AdaptationModifier : GTLRObject + +/** Optional. The modifier name. */ +@property(nonatomic, copy, nullable) NSString *modifier; + +/** + * Optional. The value of the modifier. The actual value depends on the + * modifier and can also be empty. + */ +@property(nonatomic, copy, nullable) NSString *value; + +@end + + /** * AdaptingOSStep contains specific step details. */ @@ -2833,6 +2852,12 @@ FOUNDATION_EXTERN NSString * const kGTLRVMMigrationService_VmwareVmDetails_Power */ @interface GTLRVMMigrationService_ComputeEngineTargetDefaults : GTLRObject +/** + * Optional. AdaptationModifiers are the set of modifiers used during OS + * adaptation. + */ +@property(nonatomic, strong, nullable) NSArray *adaptationModifiers; + /** Additional licenses to assign to the VM. */ @property(nonatomic, strong, nullable) NSArray *additionalLicenses; @@ -3019,6 +3044,12 @@ FOUNDATION_EXTERN NSString * const kGTLRVMMigrationService_VmwareVmDetails_Power */ @interface GTLRVMMigrationService_ComputeEngineTargetDetails : GTLRObject +/** + * Optional. Modifiers to be used as configuration of the OS adaptation + * process. + */ +@property(nonatomic, strong, nullable) NSArray *adaptationModifiers; + /** Additional licenses to assign to the VM. */ @property(nonatomic, strong, nullable) NSArray *additionalLicenses; @@ -4166,6 +4197,12 @@ FOUNDATION_EXTERN NSString * const kGTLRVMMigrationService_VmwareVmDetails_Power */ @interface GTLRVMMigrationService_ImageImportOsAdaptationParameters : GTLRObject +/** + * Optional. Modifiers to be used as configuration of the OS adaptation + * process. + */ +@property(nonatomic, strong, nullable) NSArray *adaptationModifiers; + /** * Optional. By default the image will keep its existing boot option. Setting * this property will trigger an internal process which will convert the image diff --git a/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceQuery.h b/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceQuery.h index c6b985046..92713aa07 100644 --- a/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceQuery.h +++ b/Sources/GeneratedServices/VMMigrationService/Public/GoogleAPIClientForREST/GTLRVMMigrationServiceQuery.h @@ -523,7 +523,7 @@ FOUNDATION_EXTERN NSString * const kGTLRVMMigrationServiceViewUtilizationReportV @end /** - * Initiates the cancellation of a running clone job. + * Initiates the cancellation of a running ImageImportJob. * * Method: vmmigration.projects.locations.imageImports.imageImportJobs.cancel * @@ -538,7 +538,7 @@ FOUNDATION_EXTERN NSString * const kGTLRVMMigrationServiceViewUtilizationReportV /** * Fetches a @c GTLRVMMigrationService_Operation. * - * Initiates the cancellation of a running clone job. + * Initiates the cancellation of a running ImageImportJob. * * @param object The @c GTLRVMMigrationService_CancelImageImportJobRequest to * include in the query. diff --git a/Sources/GeneratedServices/VMwareEngine/Public/GoogleAPIClientForREST/GTLRVMwareEngineQuery.h b/Sources/GeneratedServices/VMwareEngine/Public/GoogleAPIClientForREST/GTLRVMwareEngineQuery.h index 1ff9a00b0..c10524e46 100644 --- a/Sources/GeneratedServices/VMwareEngine/Public/GoogleAPIClientForREST/GTLRVMwareEngineQuery.h +++ b/Sources/GeneratedServices/VMwareEngine/Public/GoogleAPIClientForREST/GTLRVMwareEngineQuery.h @@ -317,8 +317,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRVMwareEngineQuery_ProjectsLocationsList : GTLRVMwareEngineQuery /** - * Optional. A list of extra location types that should be used as conditions - * for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/WebRisk/GTLRWebRiskObjects.m b/Sources/GeneratedServices/WebRisk/GTLRWebRiskObjects.m index 5146e1e33..6fec8eace 100644 --- a/Sources/GeneratedServices/WebRisk/GTLRWebRiskObjects.m +++ b/Sources/GeneratedServices/WebRisk/GTLRWebRiskObjects.m @@ -210,11 +210,12 @@ @implementation GTLRWebRisk_GoogleLongrunningCancelOperationRequest // @implementation GTLRWebRisk_GoogleLongrunningListOperationsResponse -@dynamic nextPageToken, operations; +@dynamic nextPageToken, operations, unreachable; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ - @"operations" : [GTLRWebRisk_GoogleLongrunningOperation class] + @"operations" : [GTLRWebRisk_GoogleLongrunningOperation class], + @"unreachable" : [NSString class] }; return map; } diff --git a/Sources/GeneratedServices/WebRisk/GTLRWebRiskQuery.m b/Sources/GeneratedServices/WebRisk/GTLRWebRiskQuery.m index d0c4d4c3b..9361ac743 100644 --- a/Sources/GeneratedServices/WebRisk/GTLRWebRiskQuery.m +++ b/Sources/GeneratedServices/WebRisk/GTLRWebRiskQuery.m @@ -131,7 +131,7 @@ + (instancetype)queryWithName:(NSString *)name { @implementation GTLRWebRiskQuery_ProjectsOperationsList -@dynamic filter, name, pageSize, pageToken; +@dynamic filter, name, pageSize, pageToken, returnPartialSuccess; + (instancetype)queryWithName:(NSString *)name { NSArray *pathParams = @[ @"name" ]; diff --git a/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskObjects.h b/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskObjects.h index cbe606cc0..5cb077847 100644 --- a/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskObjects.h +++ b/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskObjects.h @@ -455,6 +455,13 @@ FOUNDATION_EXTERN NSString * const kGTLRWebRisk_GoogleCloudWebriskV1SearchUrisRe */ @property(nonatomic, strong, nullable) NSArray *operations; +/** + * Unordered list. Unreachable resources. Populated when the request sets + * `ListOperationsRequest.return_partial_success` and reads across collections + * e.g. when attempting to list all resources across all supported locations. + */ +@property(nonatomic, strong, nullable) NSArray *unreachable; + @end diff --git a/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskQuery.h b/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskQuery.h index 451302db2..0360b996f 100644 --- a/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskQuery.h +++ b/Sources/GeneratedServices/WebRisk/Public/GoogleAPIClientForREST/GTLRWebRiskQuery.h @@ -307,6 +307,17 @@ FOUNDATION_EXTERN NSString * const kGTLRWebRiskThreatTypesUnwantedSoftware; /** The standard list page token. */ @property(nonatomic, copy, nullable) NSString *pageToken; +/** + * 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 e.g. when `parent` is set to + * `"projects/example/locations/-"`. This field is not by default supported and + * will result in an `UNIMPLEMENTED` error if set unless explicitly documented + * otherwise in service or product specific documentation. + */ +@property(nonatomic, assign) BOOL returnPartialSuccess; + /** * Fetches a @c GTLRWebRisk_GoogleLongrunningListOperationsResponse. * diff --git a/Sources/GeneratedServices/Webfonts/GTLRWebfontsObjects.m b/Sources/GeneratedServices/Webfonts/GTLRWebfontsObjects.m index 24ee87066..20dcf6e8a 100644 --- a/Sources/GeneratedServices/Webfonts/GTLRWebfontsObjects.m +++ b/Sources/GeneratedServices/Webfonts/GTLRWebfontsObjects.m @@ -21,6 +21,16 @@ @implementation GTLRWebfonts_Axis @end +// ---------------------------------------------------------------------------- +// +// GTLRWebfonts_Tag +// + +@implementation GTLRWebfonts_Tag +@dynamic name, weight; +@end + + // ---------------------------------------------------------------------------- // // GTLRWebfonts_Webfont @@ -28,13 +38,14 @@ @implementation GTLRWebfonts_Axis @implementation GTLRWebfonts_Webfont @dynamic axes, category, colorCapabilities, family, files, kind, lastModified, - menu, subsets, variants, version; + menu, subsets, tags, variants, version; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @"axes" : [GTLRWebfonts_Axis class], @"colorCapabilities" : [NSString class], @"subsets" : [NSString class], + @"tags" : [GTLRWebfonts_Tag class], @"variants" : [NSString class] }; return map; diff --git a/Sources/GeneratedServices/Webfonts/GTLRWebfontsQuery.m b/Sources/GeneratedServices/Webfonts/GTLRWebfontsQuery.m index 3578037c5..20217ed48 100644 --- a/Sources/GeneratedServices/Webfonts/GTLRWebfontsQuery.m +++ b/Sources/GeneratedServices/Webfonts/GTLRWebfontsQuery.m @@ -18,6 +18,7 @@ // capability NSString * const kGTLRWebfontsCapabilityCapabilityUnspecified = @"CAPABILITY_UNSPECIFIED"; +NSString * const kGTLRWebfontsCapabilityFamilyTags = @"FAMILY_TAGS"; NSString * const kGTLRWebfontsCapabilityVf = @"VF"; NSString * const kGTLRWebfontsCapabilityWoff2 = @"WOFF2"; diff --git a/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsObjects.h b/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsObjects.h index 7db8add12..2eae48a41 100644 --- a/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsObjects.h +++ b/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsObjects.h @@ -16,6 +16,7 @@ #endif @class GTLRWebfonts_Axis; +@class GTLRWebfonts_Tag; @class GTLRWebfonts_Webfont; @class GTLRWebfonts_Webfont_Files; @@ -51,6 +52,24 @@ NS_ASSUME_NONNULL_BEGIN @end +/** + * Metadata for a tag. + */ +@interface GTLRWebfonts_Tag : GTLRObject + +/** The name of the tag. */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * The weight of the tag. + * + * Uses NSNumber of floatValue. + */ +@property(nonatomic, strong, nullable) NSNumber *weight; + +@end + + /** * Metadata describing a family of fonts. */ @@ -89,6 +108,9 @@ NS_ASSUME_NONNULL_BEGIN /** The scripts supported by the font. */ @property(nonatomic, strong, nullable) NSArray *subsets; +/** The tags that apply to this family. */ +@property(nonatomic, strong, nullable) NSArray *tags; + /** The available variants for the font. */ @property(nonatomic, strong, nullable) NSArray *variants; diff --git a/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsQuery.h b/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsQuery.h index 6b85df8ed..e03c68fcc 100644 --- a/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsQuery.h +++ b/Sources/GeneratedServices/Webfonts/Public/GoogleAPIClientForREST/GTLRWebfontsQuery.h @@ -34,6 +34,12 @@ NS_ASSUME_NONNULL_BEGIN * Value: "CAPABILITY_UNSPECIFIED" */ FOUNDATION_EXTERN NSString * const kGTLRWebfontsCapabilityCapabilityUnspecified; +/** + * Include tags that apply to the entire family in the response. + * + * Value: "FAMILY_TAGS" + */ +FOUNDATION_EXTERN NSString * const kGTLRWebfontsCapabilityFamilyTags; /** * Prefer variable font files instead of static fonts instantiated at standard * weights. @@ -121,6 +127,8 @@ FOUNDATION_EXTERN NSString * const kGTLRWebfontsSortTrending; * (Value: "WOFF2") * @arg @c kGTLRWebfontsCapabilityVf Prefer variable font files instead of * static fonts instantiated at standard weights. (Value: "VF") + * @arg @c kGTLRWebfontsCapabilityFamilyTags Include tags that apply to the + * entire family in the response. (Value: "FAMILY_TAGS") */ @property(nonatomic, strong, nullable) NSArray *capability; diff --git a/Sources/GeneratedServices/Workflows/Public/GoogleAPIClientForREST/GTLRWorkflowsQuery.h b/Sources/GeneratedServices/Workflows/Public/GoogleAPIClientForREST/GTLRWorkflowsQuery.h index d59538fd0..38129e4d8 100644 --- a/Sources/GeneratedServices/Workflows/Public/GoogleAPIClientForREST/GTLRWorkflowsQuery.h +++ b/Sources/GeneratedServices/Workflows/Public/GoogleAPIClientForREST/GTLRWorkflowsQuery.h @@ -71,8 +71,8 @@ NS_ASSUME_NONNULL_BEGIN @interface GTLRWorkflowsQuery_ProjectsLocationsList : GTLRWorkflowsQuery /** - * Optional. Do not use this field. It is unsupported and is ignored unless - * explicitly documented otherwise. This is primarily for internal usage. + * Optional. Unless explicitly documented otherwise, don't use this unsupported + * field which is primarily intended for internal usage. */ @property(nonatomic, strong, nullable) NSArray *extraLocationTypes; diff --git a/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerObjects.m b/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerObjects.m index b4b8adc93..3b28de763 100644 --- a/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerObjects.m +++ b/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerObjects.m @@ -578,8 +578,8 @@ @implementation GTLRWorkloadManager_IAMPermission // @implementation GTLRWorkloadManager_Insight -@dynamic agentStatus, instanceId, sapDiscovery, sapValidation, sentTime, - sqlserverValidation, torsoValidation; +@dynamic agentStatus, instanceId, openShiftValidation, sapDiscovery, + sapValidation, sentTime, sqlserverValidation, torsoValidation; @end @@ -602,6 +602,34 @@ @implementation GTLRWorkloadManager_InstanceProperties @end +// ---------------------------------------------------------------------------- +// +// GTLRWorkloadManager_InvalidRule +// + +@implementation GTLRWorkloadManager_InvalidRule +@dynamic displayName, gcsUri, name, valiadtionError; +@end + + +// ---------------------------------------------------------------------------- +// +// GTLRWorkloadManager_InvalidRulesWrapper +// + +@implementation GTLRWorkloadManager_InvalidRulesWrapper +@dynamic invalidRules; + ++ (NSDictionary *)arrayPropertyToClassMap { + NSDictionary *map = @{ + @"invalidRules" : [GTLRWorkloadManager_InvalidRule class] + }; + return map; +} + +@end + + // ---------------------------------------------------------------------------- // // GTLRWorkloadManager_ListDiscoveredProfilesResponse @@ -743,7 +771,7 @@ + (NSString *)collectionItemsKey { // @implementation GTLRWorkloadManager_ListRulesResponse -@dynamic nextPageToken, rules; +@dynamic invalidRulesWrapper, rules; + (NSDictionary *)arrayPropertyToClassMap { NSDictionary *map = @{ @@ -752,10 +780,6 @@ @implementation GTLRWorkloadManager_ListRulesResponse return map; } -+ (NSString *)collectionItemsKey { - return @"rules"; -} - @end @@ -829,6 +853,15 @@ @implementation GTLRWorkloadManager_Notice @end +// ---------------------------------------------------------------------------- +// +// GTLRWorkloadManager_OpenShiftValidation +// + +@implementation GTLRWorkloadManager_OpenShiftValidation +@end + + // ---------------------------------------------------------------------------- // // GTLRWorkloadManager_Operation diff --git a/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerQuery.m b/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerQuery.m index 04bfde3e9..61ea4cb2c 100644 --- a/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerQuery.m +++ b/Sources/GeneratedServices/WorkloadManager/GTLRWorkloadManagerQuery.m @@ -257,6 +257,33 @@ + (instancetype)queryWithParent:(NSString *)parent { @end +@implementation GTLRWorkloadManagerQuery_ProjectsLocationsEvaluationsPatch + +@dynamic name, requestId, updateMask; + ++ (instancetype)queryWithObject:(GTLRWorkloadManager_Evaluation *)object + name:(NSString *)name { + if (object == nil) { +#if defined(DEBUG) && DEBUG + NSAssert(object != nil, @"Got a nil object"); +#endif + return nil; + } + NSArray *pathParams = @[ @"name" ]; + NSString *pathURITemplate = @"v1/{+name}"; + GTLRWorkloadManagerQuery_ProjectsLocationsEvaluationsPatch *query = + [[self alloc] initWithPathURITemplate:pathURITemplate + HTTPMethod:@"PATCH" + pathParameterNames:pathParams]; + query.bodyObject = object; + query.name = name; + query.expectedObjectClass = [GTLRWorkloadManager_Operation class]; + query.loggingName = @"workloadmanager.projects.locations.evaluations.patch"; + return query; +} + +@end + @implementation GTLRWorkloadManagerQuery_ProjectsLocationsGet @dynamic name; diff --git a/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerObjects.h b/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerObjects.h index c0e3ce932..beb43412c 100644 --- a/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerObjects.h +++ b/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerObjects.h @@ -39,10 +39,13 @@ @class GTLRWorkloadManager_IAMPermission; @class GTLRWorkloadManager_Insight; @class GTLRWorkloadManager_InstanceProperties; +@class GTLRWorkloadManager_InvalidRule; +@class GTLRWorkloadManager_InvalidRulesWrapper; @class GTLRWorkloadManager_Location; @class GTLRWorkloadManager_Location_Labels; @class GTLRWorkloadManager_Location_Metadata; @class GTLRWorkloadManager_Notice; +@class GTLRWorkloadManager_OpenShiftValidation; @class GTLRWorkloadManager_Operation; @class GTLRWorkloadManager_Operation_Metadata; @class GTLRWorkloadManager_Operation_Response; @@ -2075,6 +2078,9 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkloadManager_WorkloadProfile_Workload /** Optional. The instance id where the insight is generated from */ @property(nonatomic, copy, nullable) NSString *instanceId; +/** The insights data for the OpenShift workload validation. */ +@property(nonatomic, strong, nullable) GTLRWorkloadManager_OpenShiftValidation *openShiftValidation; + /** * The insights data for SAP system discovery. This is a copy of SAP System * proto and should get updated whenever that one changes. @@ -2122,6 +2128,37 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkloadManager_WorkloadProfile_Workload @end +/** + * Message represent an rule that failed to be validated. + */ +@interface GTLRWorkloadManager_InvalidRule : GTLRObject + +/** display name of the invalid rule */ +@property(nonatomic, copy, nullable) NSString *displayName; + +/** cloud storage destination of the invalid rule */ +@property(nonatomic, copy, nullable) NSString *gcsUri; + +/** name of the invalid rule */ +@property(nonatomic, copy, nullable) NSString *name; + +/** The error message of valdating rule formats. */ +@property(nonatomic, copy, nullable) NSString *valiadtionError; + +@end + + +/** + * Message wrappes a list of invalid rules. + */ +@interface GTLRWorkloadManager_InvalidRulesWrapper : GTLRObject + +/** The invalid rules that failed to be validated. */ +@property(nonatomic, strong, nullable) NSArray *invalidRules; + +@end + + /** * List discovered profile Response returns discovered profiles from agents * @@ -2282,23 +2319,13 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkloadManager_WorkloadProfile_Workload /** * Mesesage of response of list rules - * - * @note This class supports NSFastEnumeration and indexed subscripting over - * its "rules" property. If returned as the result of a query, it should - * support automatic pagination (when @c shouldFetchNextPages is - * enabled). */ -@interface GTLRWorkloadManager_ListRulesResponse : GTLRCollectionObject +@interface GTLRWorkloadManager_ListRulesResponse : GTLRObject -/** A token identifying a page of results the server should return. */ -@property(nonatomic, copy, nullable) NSString *nextPageToken; +/** A wrapper of the invalid rules that failed to be validated. */ +@property(nonatomic, strong, nullable) GTLRWorkloadManager_InvalidRulesWrapper *invalidRulesWrapper; -/** - * all rules in response - * - * @note This property is used to support NSFastEnumeration and indexed - * subscripting on this class. - */ +/** all rules in response */ @property(nonatomic, strong, nullable) NSArray *rules; @end @@ -2403,6 +2430,14 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkloadManager_WorkloadProfile_Workload @end +/** + * A presentation of OpenShift workload insight. The schema of OpenShift + * workloads validation related data. + */ +@interface GTLRWorkloadManager_OpenShiftValidation : GTLRObject +@end + + /** * This resource represents a long-running operation that is the result of a * network API call. diff --git a/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerQuery.h b/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerQuery.h index bf285a40c..3142c77da 100644 --- a/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerQuery.h +++ b/Sources/GeneratedServices/WorkloadManager/Public/GoogleAPIClientForREST/GTLRWorkloadManagerQuery.h @@ -535,6 +535,63 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkloadManagerEvaluationTypeSqlServer; @end +/** + * Updates the parameters of a single Evaluation. + * + * Method: workloadmanager.projects.locations.evaluations.patch + * + * Authorization scope(s): + * @c kGTLRAuthScopeWorkloadManagerCloudPlatform + */ +@interface GTLRWorkloadManagerQuery_ProjectsLocationsEvaluationsPatch : GTLRWorkloadManagerQuery + +/** + * name of resource names have the form + * 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' + */ +@property(nonatomic, copy, nullable) NSString *name; + +/** + * Optional. An optional request ID to identify requests. Specify a unique + * request ID so that if you must retry your request, the server will know to + * ignore the request if it has already been completed. The server will + * guarantee that for at least 60 minutes since the first request. For example, + * consider a situation where you make an initial request and the request times + * out. If you make the request again with the same request ID, the server can + * check if original operation with the same request ID was received, and if + * so, will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with the + * exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ +@property(nonatomic, copy, nullable) NSString *requestId; + +/** + * Required. Field mask is used to specify the fields to be overwritten in the + * Evaluation resource by the update. The fields specified in the update_mask + * are relative to the resource, not the full request. A field will be + * overwritten if it is in the mask. + * + * String format is a comma-separated list of fields. + */ +@property(nonatomic, copy, nullable) NSString *updateMask; + +/** + * Fetches a @c GTLRWorkloadManager_Operation. + * + * Updates the parameters of a single Evaluation. + * + * @param object The @c GTLRWorkloadManager_Evaluation to include in the query. + * @param name name of resource names have the form + * 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' + * + * @return GTLRWorkloadManagerQuery_ProjectsLocationsEvaluationsPatch + */ ++ (instancetype)queryWithObject:(GTLRWorkloadManager_Evaluation *)object + name:(NSString *)name; + +@end + /** * Gets information about a location. * @@ -903,10 +960,6 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkloadManagerEvaluationTypeSqlServer; * pre-defined rules are global available to all projects and all regions * * @return GTLRWorkloadManagerQuery_ProjectsLocationsRulesList - * - * @note Automatic pagination will be done when @c shouldFetchNextPages is - * enabled. See @c shouldFetchNextPages on @c GTLRService for more - * information. */ + (instancetype)queryWithParent:(NSString *)parent; diff --git a/Sources/GeneratedServices/WorkspaceEvents/GTLRWorkspaceEventsService.m b/Sources/GeneratedServices/WorkspaceEvents/GTLRWorkspaceEventsService.m index 711d08a14..68e1cc93b 100644 --- a/Sources/GeneratedServices/WorkspaceEvents/GTLRWorkspaceEventsService.m +++ b/Sources/GeneratedServices/WorkspaceEvents/GTLRWorkspaceEventsService.m @@ -15,6 +15,7 @@ // Authorization scopes NSString * const kGTLRAuthScopeWorkspaceEventsChatAppMemberships = @"https://www.googleapis.com/auth/chat.app.memberships"; +NSString * const kGTLRAuthScopeWorkspaceEventsChatAppMessagesReadonly = @"https://www.googleapis.com/auth/chat.app.messages.readonly"; NSString * const kGTLRAuthScopeWorkspaceEventsChatAppSpaces = @"https://www.googleapis.com/auth/chat.app.spaces"; NSString * const kGTLRAuthScopeWorkspaceEventsChatBot = @"https://www.googleapis.com/auth/chat.bot"; NSString * const kGTLRAuthScopeWorkspaceEventsChatMemberships = @"https://www.googleapis.com/auth/chat.memberships"; diff --git a/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsObjects.h b/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsObjects.h index 123803f0f..58a7886bc 100644 --- a/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsObjects.h +++ b/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsObjects.h @@ -347,10 +347,13 @@ FOUNDATION_EXTERN NSString * const kGTLRWorkspaceEvents_Subscription_SuspensionR @interface GTLRWorkspaceEvents_Subscription : GTLRObject /** - * Output only. The user who authorized the creation of the subscription. - * Format: `users/{user}` For Google Workspace users, the `{user}` value is the + * Output only. The user who authorized the creation of the subscription. When + * a user authorizes the subscription, this field and the `user_authority` + * field have the same value and the format is: Format: `users/{user}` For + * Google Workspace users, the `{user}` value is the * [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) - * field from the Directory API. + * field from the Directory API. When a Chat app authorizes the subscription, + * only `service_account_authority` field populates and this field is empty. */ @property(nonatomic, copy, nullable) NSString *authority; diff --git a/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsQuery.h b/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsQuery.h index f48fa5aff..364c37120 100644 --- a/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsQuery.h +++ b/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsQuery.h @@ -83,11 +83,23 @@ NS_ASSUME_NONNULL_BEGIN * Creates a Google Workspace subscription. To learn how to use this method, * see [Create a Google Workspace * subscription](https://developers.google.com/workspace/events/guides/create-subscription). + * For a subscription on a [Chat target + * resource](https://developers.google.com/workspace/events/guides/events-chat), + * you can create a subscription as: - A Chat app by specifying an + * authorization scope that begins with `chat.app` and getting one-time + * administrator approval ([Developer + * Preview](https://developers.google.com/workspace/preview)). To learn more, + * see [Authorize as a Chat app with administrator + * approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * - A user by specifying an authorization scope that doesn't include `app` in + * its name. To learn more, see [Authorize as a Chat + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Method: workspaceevents.subscriptions.create * * Authorization scope(s): * @c kGTLRAuthScopeWorkspaceEventsChatAppMemberships + * @c kGTLRAuthScopeWorkspaceEventsChatAppMessagesReadonly * @c kGTLRAuthScopeWorkspaceEventsChatAppSpaces * @c kGTLRAuthScopeWorkspaceEventsChatMemberships * @c kGTLRAuthScopeWorkspaceEventsChatMembershipsReadonly @@ -119,6 +131,17 @@ NS_ASSUME_NONNULL_BEGIN * Creates a Google Workspace subscription. To learn how to use this method, * see [Create a Google Workspace * subscription](https://developers.google.com/workspace/events/guides/create-subscription). + * For a subscription on a [Chat target + * resource](https://developers.google.com/workspace/events/guides/events-chat), + * you can create a subscription as: - A Chat app by specifying an + * authorization scope that begins with `chat.app` and getting one-time + * administrator approval ([Developer + * Preview](https://developers.google.com/workspace/preview)). To learn more, + * see [Authorize as a Chat app with administrator + * approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * - A user by specifying an authorization scope that doesn't include `app` in + * its name. To learn more, see [Authorize as a Chat + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * @param object The @c GTLRWorkspaceEvents_Subscription to include in the * query. @@ -327,11 +350,23 @@ NS_ASSUME_NONNULL_BEGIN * Updates or renews a Google Workspace subscription. To learn how to use this * method, see [Update or renew a Google Workspace * subscription](https://developers.google.com/workspace/events/guides/update-subscription). + * For a subscription on a [Chat target + * resource](https://developers.google.com/workspace/events/guides/events-chat), + * you can update a subscription as: - A Chat app by specifying an + * authorization scope that begins with `chat.app` andgetting one-time + * administrator approval ([Developer + * Preview](https://developers.google.com/workspace/preview)). To learn more, + * see [Authorize as a Chat app with administrator + * approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * - A user by specifying an authorization scope that doesn't include `app` in + * its name. To learn more, see [Authorize as a Chat + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Method: workspaceevents.subscriptions.patch * * Authorization scope(s): * @c kGTLRAuthScopeWorkspaceEventsChatAppMemberships + * @c kGTLRAuthScopeWorkspaceEventsChatAppMessagesReadonly * @c kGTLRAuthScopeWorkspaceEventsChatAppSpaces * @c kGTLRAuthScopeWorkspaceEventsChatMemberships * @c kGTLRAuthScopeWorkspaceEventsChatMembershipsReadonly @@ -382,6 +417,17 @@ NS_ASSUME_NONNULL_BEGIN * Updates or renews a Google Workspace subscription. To learn how to use this * method, see [Update or renew a Google Workspace * subscription](https://developers.google.com/workspace/events/guides/update-subscription). + * For a subscription on a [Chat target + * resource](https://developers.google.com/workspace/events/guides/events-chat), + * you can update a subscription as: - A Chat app by specifying an + * authorization scope that begins with `chat.app` andgetting one-time + * administrator approval ([Developer + * Preview](https://developers.google.com/workspace/preview)). To learn more, + * see [Authorize as a Chat app with administrator + * approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * - A user by specifying an authorization scope that doesn't include `app` in + * its name. To learn more, see [Authorize as a Chat + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * @param object The @c GTLRWorkspaceEvents_Subscription to include in the * query. @@ -402,11 +448,23 @@ NS_ASSUME_NONNULL_BEGIN * ignore or reject any subscription that isn't currently in a suspended state. * To learn how to use this method, see [Reactivate a Google Workspace * subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). + * For a subscription on a [Chat target + * resource](https://developers.google.com/workspace/events/guides/events-chat), + * you can reactivate a subscription as: - A Chat app by specifying an + * authorization scope that begins with `chat.app` andgetting one-time + * administrator approval ([Developer + * Preview](https://developers.google.com/workspace/preview)). To learn more, + * see [Authorize as a Chat app with administrator + * approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * - A user by specifying an authorization scope that doesn't include `app` in + * its name. To learn more, see [Authorize as a Chat + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * Method: workspaceevents.subscriptions.reactivate * * Authorization scope(s): * @c kGTLRAuthScopeWorkspaceEventsChatAppMemberships + * @c kGTLRAuthScopeWorkspaceEventsChatAppMessagesReadonly * @c kGTLRAuthScopeWorkspaceEventsChatAppSpaces * @c kGTLRAuthScopeWorkspaceEventsChatMemberships * @c kGTLRAuthScopeWorkspaceEventsChatMembershipsReadonly @@ -441,6 +499,17 @@ NS_ASSUME_NONNULL_BEGIN * ignore or reject any subscription that isn't currently in a suspended state. * To learn how to use this method, see [Reactivate a Google Workspace * subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). + * For a subscription on a [Chat target + * resource](https://developers.google.com/workspace/events/guides/events-chat), + * you can reactivate a subscription as: - A Chat app by specifying an + * authorization scope that begins with `chat.app` andgetting one-time + * administrator approval ([Developer + * Preview](https://developers.google.com/workspace/preview)). To learn more, + * see [Authorize as a Chat app with administrator + * approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * - A user by specifying an authorization scope that doesn't include `app` in + * its name. To learn more, see [Authorize as a Chat + * user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). * * @param object The @c GTLRWorkspaceEvents_ReactivateSubscriptionRequest to * include in the query. diff --git a/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsService.h b/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsService.h index 97483b8e5..120b2fc1d 100644 --- a/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsService.h +++ b/Sources/GeneratedServices/WorkspaceEvents/Public/GoogleAPIClientForREST/GTLRWorkspaceEventsService.h @@ -32,6 +32,13 @@ NS_ASSUME_NONNULL_BEGIN * Value "https://www.googleapis.com/auth/chat.app.memberships" */ FOUNDATION_EXTERN NSString * const kGTLRAuthScopeWorkspaceEventsChatAppMemberships; +/** + * Authorization scope: On their own behalf, apps in Google Chat can see all + * messages and their associated reactions and message content + * + * Value "https://www.googleapis.com/auth/chat.app.messages.readonly" + */ +FOUNDATION_EXTERN NSString * const kGTLRAuthScopeWorkspaceEventsChatAppMessagesReadonly; /** * Authorization scope: On their own behalf, apps in Google Chat can create * conversations and spaces and see or update their metadata (including history