Cloud Talent Solution V4beta1 API - Class Google::Cloud::Talent::V4beta1::Job (v0.5.0)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Cloud Talent Solution V4beta1 API class Google::Cloud::Talent::V4beta1::Job.

A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#addresses

def addresses() -> ::Array<::String>
Returns
  • (::Array<::String>) — Strongly recommended for the best service experience.

    Location(s) where the employer is looking to hire for this job posting.

    Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time.

    At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience.

    The maximum number of allowed characters is 500.

#addresses=

def addresses=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Strongly recommended for the best service experience.

    Location(s) where the employer is looking to hire for this job posting.

    Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time.

    At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience.

    The maximum number of allowed characters is 500.

Returns
  • (::Array<::String>) — Strongly recommended for the best service experience.

    Location(s) where the employer is looking to hire for this job posting.

    Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time.

    At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience.

    The maximum number of allowed characters is 500.

#application_info

def application_info() -> ::Google::Cloud::Talent::V4beta1::Job::ApplicationInfo
Returns

#application_info=

def application_info=(value) -> ::Google::Cloud::Talent::V4beta1::Job::ApplicationInfo
Parameter
Returns

#company

def company() -> ::String
Returns
  • (::String) — Required. The resource name of the company listing the job.

    The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".

    If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

#company=

def company=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the company listing the job.

    The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".

    If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

Returns
  • (::String) — Required. The resource name of the company listing the job.

    The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz".

    If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

#company_display_name

def company_display_name() -> ::String
Returns
  • (::String) — Output only. Display name of the company listing the job.

#compensation_info

def compensation_info() -> ::Google::Cloud::Talent::V4beta1::CompensationInfo
Returns

#compensation_info=

def compensation_info=(value) -> ::Google::Cloud::Talent::V4beta1::CompensationInfo
Parameter
Returns

#custom_attributes

def custom_attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Talent::V4beta1::CustomAttribute}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Talent::V4beta1::CustomAttribute}) — A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields.

    The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.

    At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB.

#custom_attributes=

def custom_attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Talent::V4beta1::CustomAttribute}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Talent::V4beta1::CustomAttribute}) — A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields.

    The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.

    At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Talent::V4beta1::CustomAttribute}) — A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields.

    The keys of the map are strings up to 64 bytes and must match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.

    At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB.

#degree_types

def degree_types() -> ::Array<::Google::Cloud::Talent::V4beta1::DegreeType>
Returns

#degree_types=

def degree_types=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::DegreeType>
Parameter
Returns

#department

def department() -> ::String
Returns
  • (::String) — The department or functional area within the company with the open position.

    The maximum number of allowed characters is 255.

#department=

def department=(value) -> ::String
Parameter
  • value (::String) — The department or functional area within the company with the open position.

    The maximum number of allowed characters is 255.

Returns
  • (::String) — The department or functional area within the company with the open position.

    The maximum number of allowed characters is 255.

#derived_info

def derived_info() -> ::Google::Cloud::Talent::V4beta1::Job::DerivedInfo
Returns

#description

def description() -> ::String
Returns
  • (::String) — Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 100,000.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 100,000.

Returns
  • (::String) — Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 100,000.

#employment_types

def employment_types() -> ::Array<::Google::Cloud::Talent::V4beta1::EmploymentType>
Returns

#employment_types=

def employment_types=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::EmploymentType>
Parameter
Returns

#incentives

def incentives() -> ::String
Returns
  • (::String) — A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay.

    The maximum number of allowed characters is 10,000.

#incentives=

def incentives=(value) -> ::String
Parameter
  • value (::String) — A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay.

    The maximum number of allowed characters is 10,000.

Returns
  • (::String) — A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay.

    The maximum number of allowed characters is 10,000.

#job_benefits

def job_benefits() -> ::Array<::Google::Cloud::Talent::V4beta1::JobBenefit>
Returns

#job_benefits=

def job_benefits=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::JobBenefit>
Parameter
Returns

#job_end_time

def job_end_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

#job_end_time=

def job_end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
Returns
  • (::Google::Protobuf::Timestamp) — The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

#job_level

def job_level() -> ::Google::Cloud::Talent::V4beta1::JobLevel
Returns

#job_level=

def job_level=(value) -> ::Google::Cloud::Talent::V4beta1::JobLevel
Parameter
Returns

#job_start_time

def job_start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

#job_start_time=

def job_start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
Returns
  • (::Google::Protobuf::Timestamp) — The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.

#language_code

def language_code() -> ::String
Returns
  • (::String) — The language of the posting. This field is distinct from any requirements for fluency that are associated with the job.

    Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages{: class="external" target="_blank" }.

    If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — The language of the posting. This field is distinct from any requirements for fluency that are associated with the job.

    Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages{: class="external" target="_blank" }.

    If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.

Returns
  • (::String) — The language of the posting. This field is distinct from any requirements for fluency that are associated with the job.

    Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages{: class="external" target="_blank" }.

    If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.

#name

def name() -> ::String
Returns
  • (::String) — Required during job update.

    The resource name for the job. This is generated by the service when a job is created.

    The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

    If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

    Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required during job update.

    The resource name for the job. This is generated by the service when a job is created.

    The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

    If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

    Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

Returns
  • (::String) — Required during job update.

    The resource name for the job. This is generated by the service when a job is created.

    The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

    If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

    Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

#posting_create_time

def posting_create_time() -> ::Google::Protobuf::Timestamp
Returns

#posting_expire_time

def posting_expire_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Strongly recommended for the best service experience.

    The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id.

    The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out.

    Invalid timestamps are ignored, and treated as expire time not provided.

    If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as [Application][google.cloud.talent.v4beta1.Application], to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one.

    If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

    If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.

#posting_expire_time=

def posting_expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Strongly recommended for the best service experience.

    The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id.

    The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out.

    Invalid timestamps are ignored, and treated as expire time not provided.

    If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as [Application][google.cloud.talent.v4beta1.Application], to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one.

    If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

    If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.

Returns
  • (::Google::Protobuf::Timestamp) — Strongly recommended for the best service experience.

    The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id.

    The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out.

    Invalid timestamps are ignored, and treated as expire time not provided.

    If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as [Application][google.cloud.talent.v4beta1.Application], to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one.

    If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.

    If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.

#posting_publish_time

def posting_publish_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.

#posting_publish_time=

def posting_publish_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.
Returns
  • (::Google::Protobuf::Timestamp) — The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.

#posting_region

def posting_region() -> ::Google::Cloud::Talent::V4beta1::PostingRegion
Returns

#posting_region=

def posting_region=(value) -> ::Google::Cloud::Talent::V4beta1::PostingRegion
Parameter
Returns

#posting_update_time

def posting_update_time() -> ::Google::Protobuf::Timestamp
Returns

#processing_options

def processing_options() -> ::Google::Cloud::Talent::V4beta1::Job::ProcessingOptions
Returns

#processing_options=

def processing_options=(value) -> ::Google::Cloud::Talent::V4beta1::Job::ProcessingOptions
Parameter
Returns

#promotion_value

def promotion_value() -> ::Integer
Returns
  • (::Integer) — A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

    Default value is 0, and negative values are treated as 0.

#promotion_value=

def promotion_value=(value) -> ::Integer
Parameter
  • value (::Integer) — A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

    Default value is 0, and negative values are treated as 0.

Returns
  • (::Integer) — A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.

    Default value is 0, and negative values are treated as 0.

#qualifications

def qualifications() -> ::String
Returns
  • (::String) — A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 10,000.

#qualifications=

def qualifications=(value) -> ::String
Parameter
  • value (::String) — A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 10,000.

Returns
  • (::String) — A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 10,000.

#requisition_id

def requisition_id() -> ::String
Returns
  • (::String) — Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id.

    The maximum number of allowed characters is 255.

#requisition_id=

def requisition_id=(value) -> ::String
Parameter
  • value (::String) — Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id.

    The maximum number of allowed characters is 255.

Returns
  • (::String) — Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id.

    The maximum number of allowed characters is 255.

#responsibilities

def responsibilities() -> ::String
Returns
  • (::String) — A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 10,000.

#responsibilities=

def responsibilities=(value) -> ::String
Parameter
  • value (::String) — A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 10,000.

Returns
  • (::String) — A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field.

    This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.

    The maximum number of allowed characters is 10,000.

#title

def title() -> ::String
Returns
  • (::String) — Required. The title of the job, such as "Software Engineer"

    The maximum number of allowed characters is 500.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — Required. The title of the job, such as "Software Engineer"

    The maximum number of allowed characters is 500.

Returns
  • (::String) — Required. The title of the job, such as "Software Engineer"

    The maximum number of allowed characters is 500.

#visibility

def visibility() -> ::Google::Cloud::Talent::V4beta1::Visibility
Returns

#visibility=

def visibility=(value) -> ::Google::Cloud::Talent::V4beta1::Visibility
Parameter
Returns