com.clarifai.grpc.api.KeyOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: proto/clarifai/api/resources.proto
package com.clarifai.grpc.api;
public interface KeyOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.Key)
com.google.protobuf.MessageOrBuilder {
/**
*
* The id of this key, it is used for authorization.
*
*
* string id = 1;
* @return The id.
*/
java.lang.String getId();
/**
*
* The id of this key, it is used for authorization.
*
*
* string id = 1;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* The type of key, it can be api_key or personal_access_token, the default value is api_key
*
*
* string type = 8;
* @return The type.
*/
java.lang.String getType();
/**
*
* The type of key, it can be api_key or personal_access_token, the default value is api_key
*
*
* string type = 8;
* @return The bytes for type.
*/
com.google.protobuf.ByteString
getTypeBytes();
/**
*
* The description
*
*
* string description = 2;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* The description
*
*
* string description = 2;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* The low-level scopes this key has
*
*
* repeated string scopes = 3;
* @return A list containing the scopes.
*/
java.util.List
getScopesList();
/**
*
* The low-level scopes this key has
*
*
* repeated string scopes = 3;
* @return The count of scopes.
*/
int getScopesCount();
/**
*
* The low-level scopes this key has
*
*
* repeated string scopes = 3;
* @param index The index of the element to return.
* @return The scopes at the given index.
*/
java.lang.String getScopes(int index);
/**
*
* The low-level scopes this key has
*
*
* repeated string scopes = 3;
* @param index The index of the value to return.
* @return The bytes of the scopes at the given index.
*/
com.google.protobuf.ByteString
getScopesBytes(int index);
/**
*
* The endpoint-level scopes this key has
*
*
* repeated string endpoints = 7;
* @return A list containing the endpoints.
*/
java.util.List
getEndpointsList();
/**
*
* The endpoint-level scopes this key has
*
*
* repeated string endpoints = 7;
* @return The count of endpoints.
*/
int getEndpointsCount();
/**
*
* The endpoint-level scopes this key has
*
*
* repeated string endpoints = 7;
* @param index The index of the element to return.
* @return The endpoints at the given index.
*/
java.lang.String getEndpoints(int index);
/**
*
* The endpoint-level scopes this key has
*
*
* repeated string endpoints = 7;
* @param index The index of the value to return.
* @return The bytes of the endpoints at the given index.
*/
com.google.protobuf.ByteString
getEndpointsBytes(int index);
/**
*
* The apps that this key give you access to, it is empty if this key is personal_access_token
* API key can only give you access to a single app.
*
*
* repeated .clarifai.api.App apps = 4;
*/
java.util.List
getAppsList();
/**
*
* The apps that this key give you access to, it is empty if this key is personal_access_token
* API key can only give you access to a single app.
*
*
* repeated .clarifai.api.App apps = 4;
*/
com.clarifai.grpc.api.App getApps(int index);
/**
*
* The apps that this key give you access to, it is empty if this key is personal_access_token
* API key can only give you access to a single app.
*
*
* repeated .clarifai.api.App apps = 4;
*/
int getAppsCount();
/**
*
* The apps that this key give you access to, it is empty if this key is personal_access_token
* API key can only give you access to a single app.
*
*
* repeated .clarifai.api.App apps = 4;
*/
java.util.List
getAppsOrBuilderList();
/**
*
* The apps that this key give you access to, it is empty if this key is personal_access_token
* API key can only give you access to a single app.
*
*
* repeated .clarifai.api.App apps = 4;
*/
com.clarifai.grpc.api.AppOrBuilder getAppsOrBuilder(
int index);
/**
*
* When the key was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 5;
* @return Whether the createdAt field is set.
*/
boolean hasCreatedAt();
/**
*
* When the key was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 5;
* @return The createdAt.
*/
com.google.protobuf.Timestamp getCreatedAt();
/**
*
* When the key was created. We follow the XXXX timestamp
* format. We use https://www.ietf.org/rfc/rfc3339.txt format:
* "2006-01-02T15:04:05.999999Z" so you can expect results like
* the following from the API:
* "2017-04-11T21:50:50.223962Z"
*
*
* .google.protobuf.Timestamp created_at = 5;
*/
com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();
/**
*
* When does the key expires, the key won't expire if this is empty
*
*
* .google.protobuf.Timestamp expires_at = 6;
* @return Whether the expiresAt field is set.
*/
boolean hasExpiresAt();
/**
*
* When does the key expires, the key won't expire if this is empty
*
*
* .google.protobuf.Timestamp expires_at = 6;
* @return The expiresAt.
*/
com.google.protobuf.Timestamp getExpiresAt();
/**
*
* When does the key expires, the key won't expire if this is empty
*
*
* .google.protobuf.Timestamp expires_at = 6;
*/
com.google.protobuf.TimestampOrBuilder getExpiresAtOrBuilder();
/**
*
* list of idp ids at which key is currently authorized
*
*
* repeated string authorized_idp_ids = 9;
* @return A list containing the authorizedIdpIds.
*/
java.util.List
getAuthorizedIdpIdsList();
/**
*
* list of idp ids at which key is currently authorized
*
*
* repeated string authorized_idp_ids = 9;
* @return The count of authorizedIdpIds.
*/
int getAuthorizedIdpIdsCount();
/**
*
* list of idp ids at which key is currently authorized
*
*
* repeated string authorized_idp_ids = 9;
* @param index The index of the element to return.
* @return The authorizedIdpIds at the given index.
*/
java.lang.String getAuthorizedIdpIds(int index);
/**
*
* list of idp ids at which key is currently authorized
*
*
* repeated string authorized_idp_ids = 9;
* @param index The index of the value to return.
* @return The bytes of the authorizedIdpIds at the given index.
*/
com.google.protobuf.ByteString
getAuthorizedIdpIdsBytes(int index);
}