Class: Google::Apis::ContactcenteraiplatformV1alpha1::ContactCenter

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb,
lib/google/apis/contactcenteraiplatform_v1alpha1/representations.rb,
lib/google/apis/contactcenteraiplatform_v1alpha1/representations.rb

Overview

Message describing ContactCenter object Next ID: 23

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ContactCenter

Returns a new instance of ContactCenter.



199
200
201
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 199

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#admin_user ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::AdminUser

Message storing info about the first admin user. Next ID: 3 Corresponds to the JSON property adminUser

Returns:



100
101
102
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 100

def admin_user
  @admin_user
end

#ccaip_managed_users ⇒ Boolean Also known as: ccaip_managed_users?

Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity Corresponds to the JSON property ccaipManagedUsers

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 106

def ccaip_managed_users
  @ccaip_managed_users
end

#create_time ⇒ String

Output only. [Output only] Create time stamp Corresponds to the JSON property createTime

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 112

def create_time
  @create_time
end

#critical ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::Critical

Instances in this Channel will receive updates after all instances in Critical were updated + 2 days. They also will only be updated outside of their peak hours. Corresponds to the JSON property critical

Returns:



119
120
121
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 119

def critical
  @critical
end

#customer_domain_prefix ⇒ String

Required. Immutable. At least 2 and max 16 char long, must conform to RFC 1035. Corresponds to the JSON property customerDomainPrefix

Returns:

  • (String) 


125
126
127
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 125

def customer_domain_prefix
  @customer_domain_prefix
end

#display_name ⇒ String

Required. A user friendly name for the ContactCenter. Corresponds to the JSON property displayName

Returns:

  • (String) 


130
131
132
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 130

def display_name
  @display_name
end

#early ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::Early

LINT.IfChange First Channel to receive the updates. Meant to dev/test instances Corresponds to the JSON property early

Returns:



136
137
138
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 136

def early
  @early
end

#instance_config ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::InstanceConfig

Message storing the instance configuration. Corresponds to the JSON property instanceConfig

Returns:



141
142
143
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 141

def instance_config
  @instance_config
end

#kms_key ⇒ String

Immutable. The KMS key name to encrypt the user input (ContactCenter). Corresponds to the JSON property kmsKey

Returns:

  • (String) 


146
147
148
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 146

def kms_key
  @kms_key
end

#labels ⇒ Hash<String,String>

Labels as key value pairs Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


151
152
153
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 151

def labels
  @labels
end

#name ⇒ String

name of resource Corresponds to the JSON property name

Returns:

  • (String) 


156
157
158
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 156

def name
  @name
end

#normal ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::Normal

Instances in this Channel will receive updates after all instances in Early were updated + 2 days. Corresponds to the JSON property normal

Returns:



162
163
164
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 162

def normal
  @normal
end

#private_access ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::PrivateAccess

Defines ingress and egress private traffic settings for CCAIP instances. Corresponds to the JSON property privateAccess

Returns:



167
168
169
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 167

def private_access
  @private_access
end

#private_components ⇒ Array<String>

Output only. TODO(b/283407860) Deprecate this field. Corresponds to the JSON property privateComponents

Returns:

  • (Array<String>) 


172
173
174
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 172

def private_components
  @private_components
end

#saml_params ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::SamlParams

Message storing SAML params to enable Google as IDP. Corresponds to the JSON property samlParams

Returns:



177
178
179
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 177

def saml_params
  @saml_params
end

#state ⇒ String

Output only. The state of this contact center. Corresponds to the JSON property state

Returns:

  • (String) 


182
183
184
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 182

def state
  @state
end

#update_time ⇒ String

Output only. [Output only] Update time stamp Corresponds to the JSON property updateTime

Returns:

  • (String) 


187
188
189
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 187

def update_time
  @update_time
end

#uris ⇒ Google::Apis::ContactcenteraiplatformV1alpha1::UrIs

Message storing the URIs of the ContactCenter. Corresponds to the JSON property uris

Returns:



192
193
194
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 192

def uris
  @uris
end

#user_email ⇒ String

Optional. Email address of the first admin user. Corresponds to the JSON property userEmail

Returns:

  • (String) 


197
198
199
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 197

def user_email
  @user_email
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/google/apis/contactcenteraiplatform_v1alpha1/classes.rb', line 204

def update!(**args)
  @admin_user = args[:admin_user] if args.key?(:admin_user)
  @ccaip_managed_users = args[:ccaip_managed_users] if args.key?(:ccaip_managed_users)
  @create_time = args[:create_time] if args.key?(:create_time)
  @critical = args[:critical] if args.key?(:critical)
  @customer_domain_prefix = args[:customer_domain_prefix] if args.key?(:customer_domain_prefix)
  @display_name = args[:display_name] if args.key?(:display_name)
  @early = args[:early] if args.key?(:early)
  @instance_config = args[:instance_config] if args.key?(:instance_config)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @normal = args[:normal] if args.key?(:normal)
  @private_access = args[:private_access] if args.key?(:private_access)
  @private_components = args[:private_components] if args.key?(:private_components)
  @saml_params = args[:saml_params] if args.key?(:saml_params)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @uris = args[:uris] if args.key?(:uris)
  @user_email = args[:user_email] if args.key?(:user_email)
end