Class ListJobMetricsRequest

Inheritance

object

ListJobMetricsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Requests

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class ListJobMetricsRequest : IOciRequest

Examples

Click here to see an example of how to use ListJobMetrics request.

Properties

BatchKey

Declaration

[HttpConverter(TargetEnum.Query, "batchKey")]
public string BatchKey { get; set; }

Property Value

Type	Description
string	Batch key for grouping, may be null.

CatalogId

Declaration

[Required(ErrorMessage = "CatalogId is required.")]
[HttpConverter(TargetEnum.Path, "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

Category

Declaration

[HttpConverter(TargetEnum.Query, "category")]
public string Category { get; set; }

Property Value

Type	Description
string	Category of this metric.

CreatedById

Declaration

[HttpConverter(TargetEnum.Query, "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created the resource.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given. The match is not case sensitive.

DisplayNameContains

Declaration

[HttpConverter(TargetEnum.Query, "displayNameContains")]
public string DisplayNameContains { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListJobMetricsRequest.FieldsEnum> Fields { get; set; }

Property Value

Type	Description
List<ListJobMetricsRequest.FieldsEnum>	Specifies the fields to return in a job metric summary response.

JobExecutionKey

Declaration

[Required(ErrorMessage = "JobExecutionKey is required.")]
[HttpConverter(TargetEnum.Path, "jobExecutionKey")]
public string JobExecutionKey { get; set; }

Property Value

Type	Description
string	The key of the job execution.

Remarks

Required

JobKey

Declaration

[Required(ErrorMessage = "JobKey is required.")]
[HttpConverter(TargetEnum.Path, "jobKey")]
public string JobKey { get; set; }

Property Value

Type	Description
string	Unique job key.

Remarks

Required

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListJobMetricsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListJobMetricsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListJobMetricsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListJobMetricsRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'.

SubCategory

Declaration

[HttpConverter(TargetEnum.Query, "subCategory")]
public string SubCategory { get; set; }

Property Value

Type	Description
string	Sub category of this metric under the category. Used for aggregating values. May be null.

TimeCreated

Declaration

[HttpConverter(TargetEnum.Query, "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was created. An RFC3339 formatted datetime string.

TimeInserted

Declaration

[HttpConverter(TargetEnum.Query, "timeInserted")]
public DateTime? TimeInserted { get; set; }

Property Value

Type	Description
DateTime?	The time the metric was logged or captured in the system where the job executed. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[HttpConverter(TargetEnum.Query, "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was updated. An RFC3339 formatted datetime string.

Unit

Declaration

[HttpConverter(TargetEnum.Query, "unit")]
public string Unit { get; set; }

Property Value

Type	Description
string	Unit of this metric.

UpdatedById

Declaration

[HttpConverter(TargetEnum.Query, "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who updated the resource.

Value

Declaration

[HttpConverter(TargetEnum.Query, "value")]
public string Value { get; set; }

Property Value

Type	Description
string	Value of this metric.

Implements

IOciRequest