Skip to content

Latest commit

 

History

History
188 lines (132 loc) · 4.77 KB

GrafeasProjectsApi.md

File metadata and controls

188 lines (132 loc) · 4.77 KB
Raw

GrafeasProjectsApi

All URIs are relative to http://localhost

Method HTTP request Description
createProject POST /v1alpha1/projects Creates a new `Project`.
deleteProject DELETE /v1alpha1/{name} Deletes the given `Project` from the system.
getProject GET /v1alpha1/{name} Returns the requested `Project`.
listProjects GET /v1alpha1/projects Lists `Projects`

createProject

ProtobufEmpty createProject(body)

Creates a new `Project`.

Example

// Import classes:
//import io.grafeas.ApiException;
//import io.grafeas.api.GrafeasProjectsApi;


GrafeasProjectsApi apiInstance = new GrafeasProjectsApi();
ApiProject body = new ApiProject(); // ApiProject | 
try {
    ProtobufEmpty result = apiInstance.createProject(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GrafeasProjectsApi#createProject");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ApiProject

Return type

ProtobufEmpty

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteProject

ProtobufEmpty deleteProject(name)

Deletes the given `Project` from the system.

Example

// Import classes:
//import io.grafeas.ApiException;
//import io.grafeas.api.GrafeasProjectsApi;


GrafeasProjectsApi apiInstance = new GrafeasProjectsApi();
String name = "name_example"; // String | 
try {
    ProtobufEmpty result = apiInstance.deleteProject(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GrafeasProjectsApi#deleteProject");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
name String

Return type

ProtobufEmpty

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getProject

ApiProject getProject(name)

Returns the requested `Project`.

Example

// Import classes:
//import io.grafeas.ApiException;
//import io.grafeas.api.GrafeasProjectsApi;


GrafeasProjectsApi apiInstance = new GrafeasProjectsApi();
String name = "name_example"; // String | 
try {
    ApiProject result = apiInstance.getProject(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GrafeasProjectsApi#getProject");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
name String

Return type

ApiProject

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listProjects

ApiListProjectsResponse listProjects(filter, pageSize, pageToken)

Lists `Projects`

Example

// Import classes:
//import io.grafeas.ApiException;
//import io.grafeas.api.GrafeasProjectsApi;


GrafeasProjectsApi apiInstance = new GrafeasProjectsApi();
String filter = "filter_example"; // String | The filter expression.
Integer pageSize = 56; // Integer | Number of projects to return in the list.
String pageToken = "pageToken_example"; // String | Token to provide to skip to a particular spot in the list.
try {
    ApiListProjectsResponse result = apiInstance.listProjects(filter, pageSize, pageToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GrafeasProjectsApi#listProjects");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter String The filter expression. [optional]
pageSize Integer Number of projects to return in the list. [optional]
pageToken String Token to provide to skip to a particular spot in the list. [optional]

Return type

ApiListProjectsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json