com.azure.resourcemanager.security.models.ApiCollection Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.security.models;

import com.azure.resourcemanager.security.fluent.models.ApiCollectionInner;

/**
 * An immutable client-side representation of ApiCollection.
 */
public interface ApiCollection {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     * 
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     * 
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     * 
     * @return the type value.
     */
    String type();

    /**
     * Gets the provisioningState property: Gets the provisioning state of the API collection.
     * 
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the displayName property: The display name of the API collection.
     * 
     * @return the displayName value.
     */
    String displayName();

    /**
     * Gets the discoveredVia property: The resource Id of the resource from where this API collection was discovered.
     * 
     * @return the discoveredVia value.
     */
    String discoveredVia();

    /**
     * Gets the baseUrl property: The base URI for this API collection. All endpoints of this API collection extend this
     * base URI.
     * 
     * @return the baseUrl value.
     */
    String baseUrl();

    /**
     * Gets the numberOfApiEndpoints property: The number of API endpoints discovered in this API collection.
     * 
     * @return the numberOfApiEndpoints value.
     */
    Long numberOfApiEndpoints();

    /**
     * Gets the numberOfInactiveApiEndpoints property: The number of API endpoints in this API collection that have not
     * received any API traffic in the last 30 days.
     * 
     * @return the numberOfInactiveApiEndpoints value.
     */
    Long numberOfInactiveApiEndpoints();

    /**
     * Gets the numberOfUnauthenticatedApiEndpoints property: The number of API endpoints in this API collection that
     * are unauthenticated.
     * 
     * @return the numberOfUnauthenticatedApiEndpoints value.
     */
    Long numberOfUnauthenticatedApiEndpoints();

    /**
     * Gets the numberOfExternalApiEndpoints property: The number of API endpoints in this API collection for which API
     * traffic from the internet was observed.
     * 
     * @return the numberOfExternalApiEndpoints value.
     */
    Long numberOfExternalApiEndpoints();

    /**
     * Gets the numberOfApiEndpointsWithSensitiveDataExposed property: The number of API endpoints in this API
     * collection which are exposing sensitive data in their requests and/or responses.
     * 
     * @return the numberOfApiEndpointsWithSensitiveDataExposed value.
     */
    Long numberOfApiEndpointsWithSensitiveDataExposed();

    /**
     * Gets the sensitivityLabel property: The highest priority sensitivity label from Microsoft Purview in this API
     * collection.
     * 
     * @return the sensitivityLabel value.
     */
    String sensitivityLabel();

    /**
     * Gets the inner com.azure.resourcemanager.security.fluent.models.ApiCollectionInner object.
     * 
     * @return the inner object.
     */
    ApiCollectionInner innerModel();
}