Skip to content

README.md

Latest commit

 

History

History
142 lines (106 loc) · 8.95 KB

README.md

File metadata and controls

142 lines (106 loc) · 8.95 KB

Connectors

Overview

Retrieve metadata for connectors.

Available Operations

listConnectorsMeta

List Connector Meta Information

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.StackoneListConnectorsMetaResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        StackoneListConnectorsMetaResponse res = sdk.connectors().listConnectorsMeta()
                .include("field_path,unmapped_fields,resources,inactive,webhooks,static_fields")
                .call();

        if (res.connectorsMetas().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
include JsonNullable<String> ➖ The comma separated list of data that will be included in the response field_path,unmapped_fields,resources,inactive,webhooks,static_fields

Response

StackoneListConnectorsMetaResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*

getConnectorMeta

Get Connector Meta Information

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.StackoneGetConnectorMetaResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        StackoneGetConnectorMetaResponse res = sdk.connectors().getConnectorMeta()
                .provider("<value>")
                .include("field_path,unmapped_fields,resources,inactive,webhooks,static_fields")
                .call();

        if (res.connectorsMeta().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
provider String ✔️ N/A
include JsonNullable<String> ➖ The comma separated list of data that will be included in the response field_path,unmapped_fields,resources,inactive,webhooks,static_fields

Response

StackoneGetConnectorMetaResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/ForbiddenResponse 403 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/RequestTimedOutResponse 408 application/json
models/errors/ConflictResponse 409 application/json
models/errors/UnprocessableEntityResponse 422 application/json
models/errors/TooManyRequestsResponse 429 application/json
models/errors/InternalServerErrorResponse 500 application/json
models/errors/NotImplementedResponse 501 application/json
models/errors/BadGatewayResponse 502 application/json
models/errors/SDKError 4XX, 5XX */*