Class: Google::Apis::LanguageV1beta2::Document

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/language_v1beta2/classes.rb,
generated/google/apis/language_v1beta2/representations.rb,
generated/google/apis/language_v1beta2/representations.rb

Overview

##########################################################

Represents the input to API methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Document

Returns a new instance of Document.



490
491
492
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 490

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

Instance Attribute Details

#boilerplate_handling ⇒ String

Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content. Corresponds to the JSON property boilerplateHandling

Returns:

  • (String) 


450
451
452
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 450

def boilerplate_handling
  @boilerplate_handling
end

#content ⇒ String

The content of the input in string format. Cloud audit logging exempt since it is based on user data. Corresponds to the JSON property content

Returns:

  • (String) 


456
457
458
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 456

def content
  @content
end

#gcs_content_uri ⇒ String

The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported. Corresponds to the JSON property gcsContentUri

Returns:

  • (String) 


464
465
466
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 464

def gcs_content_uri
  @gcs_content_uri
end

#language ⇒ String

The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
Language Support lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property language

Returns:

  • (String) 


476
477
478
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 476

def language
  @language
end

#reference_web_uri ⇒ String

The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document. Corresponds to the JSON property referenceWebUri

Returns:

  • (String) 


482
483
484
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 482

def reference_web_uri
  @reference_web_uri
end

#type ⇒ String

Required. If the type is not set or is TYPE_UNSPECIFIED, returns an INVALID_ARGUMENT error. Corresponds to the JSON property type

Returns:

  • (String) 


488
489
490
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 488

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



495
496
497
498
499
500
501
502
 
# File 'generated/google/apis/language_v1beta2/classes.rb', line 495

def update!(**args)
  @boilerplate_handling = args[:boilerplate_handling] if args.key?(:boilerplate_handling)
  @content = args[:content] if args.key?(:content)
  @gcs_content_uri = args[:gcs_content_uri] if args.key?(:gcs_content_uri)
  @language = args[:language] if args.key?(:language)
  @reference_web_uri = args[:reference_web_uri] if args.key?(:reference_web_uri)
  @type = args[:type] if args.key?(:type)
end