Class ListWorkersRequest

Inheritance

object

ListWorkersRequest

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.ApmsyntheticsService.Requests

Assembly: OCI.DotNetSDK.Apmsynthetics.dll

Syntax

public class ListWorkersRequest : IOciRequest

Examples

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

Properties

ApmDomainId

Declaration

[Required(ErrorMessage = "ApmDomainId is required.")]
[HttpConverter(TargetEnum.Query, "apmDomainId")]
public string ApmDomainId { get; set; }

Property Value

Type	Description
string	The APM domain ID the request is intended for.

Remarks

Required

Capability

Declaration

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

Property Value

Type	Description
string	A filter to return only On-premise VP workers that match the capability given.

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only the resources that match the entire display name.

Limit

Declaration

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

Property Value

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

Name

Declaration

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

Property Value

Type	Description
string	A filter to return only the resources that match the entire name.

OnPremiseVantagePointId

Declaration

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

Property Value

Type	Description
string	The OCID of the On-premise vantage point.

Remarks

Required

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration

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

Property Value

Type	Description
string	The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination. Example: 50

SortBy

Declaration

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

Property Value

Type	Description
ListWorkersRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated, timeUpdated and timeLastSyncup is descending. The displayName sort by is case-sensitive.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrders?	The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending.

Status

Declaration

[HttpConverter(TargetEnum.Query, "status")]
public OnPremiseVantagePointWorkerStatus? Status { get; set; }

Property Value

Type	Description
OnPremiseVantagePointWorkerStatus?	A filter to return only On-premise VP workers that match the status given.

Implements

IOciRequest